Community Server REST API

The ONLYOFFICE Community Server exposes a REST API over HTTP. Every resource — a file, a CRM contact, a project task, a mail message — has its own URL and is manipulated in isolation with GET, POST, PUT and DELETE.

Requests go to the portal host, https://{host}:{port}, where the API listens on port 8092 by default.

Authentication

Every request must carry an Authorization header holding the token returned by Authenticate a user. See Passing authentication for the full exchange and for examples in several languages.

A request without a valid token is answered with 401.

Making requests

Set both the Content-Type and the Accept header to application/json. Responses are JSON: a successful call returns a status code in the 200 range and the result described on each operation page.

See Basic concepts for the conventions shared by every method.