Gets accounts entries with shared

GET /api/2.0/accounts/room/{id}/search

Request

Gets accounts entries with shared

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Path

idintegerformat: int32required

ID

Query

employeeStatusone of

Employee status

.enum of string

[Active - Active, Terminated - Terminated, Pending - Pending, Default - Default, All - All]

Can be one of: Active, Terminated, Pending, Default, All.

.enum of integer

[1 - Active, 2 - Terminated, 4 - Pending, 5 - Default, 7 - All]

Can be one of: 1, 2, 4, 5, 7.

activationStatusone of

Activation status

.enum of string

[NotActivated - Not activated, Activated - Activated, Pending - Pending, AutoGenerated - Auto generated]

Can be one of: NotActivated, Activated, Pending, AutoGenerated.

.enum of integer

[0 - Not activated, 1 - Activated, 2 - Pending, 4 - Auto generated]

Can be one of: 0, 1, 2, 4.

excludeSharedboolean

Exclude shared

invitedByMeboolean

Invited by me

inviterIdstringformat: uuid

Inviter Id

areaenum of integerformat: int32

Area

Can be one of: 0, 1, 2.

Examples

GET /api/2.0/accounts/room/5551/search?excludeShared=true&invitedByMe=true&inviterId=75a5f745-f697-4418-b38d-0fe0d277e258&area=0 HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url 'https://example.com/api/2.0/accounts/room/5551/search?excludeShared=true&invitedByMe=true&inviterId=75a5f745-f697-4418-b38d-0fe0d277e258&area=0' \
  --header 'Accept: application/json'

Responses

200

Ok

401

Unauthorized

403

No permissions to perform this action

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).