Get profiles

GET /api/2.0/people/

Request

Returns a list of profiles for all the portal users.

Authorization

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

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

Headers

Acceptenum of string

Can be one of: application/json.

Examples

GET /api/2.0/people/ HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/people/ \
  --header 'Accept: application/json'

Responses

200

List of profiles

FirstNamestring
LastNamestring
UserNamestring
Emailstring
Birthdaystring
Sexstring
Statusenum of integerformat: int32

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

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

ActivationStatusenum of integerformat: int32

[0 - NotActivated, 1 - Activated, 2 - Pending, 4 - AutoGenerated]

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

Terminatedstring
Departmentstring
WorkFromstring
Groupsarray of object
Namestring
Idstringformat: uuid
Managerstring
Locationstring
Notesstring
Leadstringformat: uuid
AvatarMediumstring
Avatarstring
IsAdminboolean
IsLDAPboolean
ListAdminModulesarray of string
IsOwnerboolean
IsVisitorboolean
CultureNamestring
IsSSOboolean
QuotaLimitintegerformat: int64
UsedSpaceintegerformat: int64
DocsSpaceintegerformat: int64
MailSpaceintegerformat: int64
TalkSpaceintegerformat: int64
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, 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).