Search users and their information by extended filter

GET /api/2.0/people/filter

Request

Returns a list of users with full information about them matching the parameters specified in the request.

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.

Query

employeeStatusone of

User 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.

groupIdstringformat: uuid

Group ID

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.

employeeTypeone of

User type

.enum of string

[All - All, RoomAdmin - Room admin, User - User, DocSpaceAdmin - DocSpace admin, Collaborator - Collaborator]

Can be one of: All, RoomAdmin, User, DocSpaceAdmin, Collaborator.

.enum of integer

[0 - All, 1 - Room admin, 2 - User, 3 - DocSpace admin, 4 - Collaborator]

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

employeeTypesarray of any of

List of user types

.enum of string

[All - All, RoomAdmin - Room admin, User - User, DocSpaceAdmin - DocSpace admin, Collaborator - Collaborator]

Can be one of: All, RoomAdmin, User, DocSpaceAdmin, Collaborator.

.enum of integer

[0 - All, 1 - Room admin, 2 - User, 3 - DocSpace admin, 4 - Collaborator]

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

isAdministratorboolean

Specifies if the user is an administrator or not

paymentsone of

User payment status

.enum of string

[Paid - Paid, Free - Free]

Can be one of: Paid, Free.

.enum of integer

[0 - Paid, 1 - Free]

Can be one of: 0, 1.

accountLoginTypeone of

Account login type

.enum of string

[SSO - SSO, LDAP - LDAP, Standart - Standart]

Can be one of: SSO, LDAP, Standart.

.enum of integer

[0 - SSO, 1 - LDAP, 2 - Standart]

Can be one of: 0, 1, 2.

quotaFilterone of

Filter by quota (Default - 1, Custom - 2)

.enum of string

[All - All, Default - Default, Custom - Custom]

Can be one of: All, Default, Custom.

.enum of integer

[0 - All, 1 - Default, 2 - Custom]

Can be one of: 0, 1, 2.

withoutGroupboolean

Specifies whether the user should be a member of a group or not

excludeGroupboolean

Specifies whether or not the user should be a member of the group with the specified ID

Examples

GET /api/2.0/people/filter?groupId=75a5f745-f697-4418-b38d-0fe0d277e258&isAdministrator=true&withoutGroup=true&excludeGroup=true HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url 'https://example.com/api/2.0/people/filter?groupId=75a5f745-f697-4418-b38d-0fe0d277e258&isAdministrator=true&withoutGroup=true&excludeGroup=true' \
  --header 'Accept: application/json'

Responses

200

List of users with the detailed information

idstringformat: uuid

displayNamestring

titlestring

avatarstring

avatarOriginalstring

avatarMaxstring

avatarMediumstring

avatarSmallstring

profileUrlstring

hasAvatarboolean

isAnonimboolean

firstNamestring

lastNamestring

userNamestring

emailstringformat: email

contactsarray of unknown

birthdayobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

sexstring

statusone of

.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

.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.

terminatedobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

departmentstring

workFromobject

utcTimestringformat: date-time

timeZoneOffsetstringformat: date-span

groupsarray of unknown

locationstring

notesstring

isAdminboolean

isRoomAdminboolean

isLDAPboolean

listAdminModulesarray of unknown

isOwnerboolean

isVisitorboolean

isCollaboratorboolean

cultureNamestring

mobilePhonestring

mobilePhoneActivationStatusone of

.enum of string

[NotActivated - Not activated, Activated - Activated]

Can be one of: NotActivated, Activated.

.enum of integer

[0 - Not activated, 1 - Activated]

Can be one of: 0, 1.

isSSOboolean

themeone of

.enum of string

[Base - Base, Dark - Dark, System - System]

Can be one of: Base, Dark, System.

.enum of integer

[0 - Base, 1 - Dark, 2 - System]

Can be one of: 0, 1, 2.

quotaLimitintegerformat: int64

usedSpacenumberformat: double

sharedboolean

isCustomQuotaboolean

loginEventIdintegerformat: int32

401

Unauthorized

403

Forbidden