Get profiles by status
GET /api/2.0/people/status/{status}Request
Returns a list of profiles filtered by user status.
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
- Accept
enum of string Can be one of:
application/json.
Path
- status
enum of integerformat: int32 User status ("Active", "Terminated", "LeaveOfAbsence", "All", or "Default")
Can be one of:
Active,Terminated,LeaveOfAbsence,Default,All.
Examples
GET /api/2.0/people/status/Active HTTP/1.1
Accept: application/json
Host: example.comcurl --request GET \
--url https://example.com/api/2.0/people/status/Active \
--header 'Accept: application/json'Responses
200
List of profiles
- FirstName
string - LastName
string - UserName
string - Email
string - Birthday
string - Sex
string - Status
enum of integerformat: int32 [1 - Active, 2 - Terminated, 4 - LeaveOfAbsence, 5 - Default, 7 - All]
Can be one of:
Active,Terminated,LeaveOfAbsence,Default,All.- ActivationStatus
enum of integerformat: int32 [0 - NotActivated, 1 - Activated, 2 - Pending, 4 - AutoGenerated]
Can be one of:
NotActivated,Activated,Pending,AutoGenerated.- Terminated
string - Department
string - WorkFrom
string - Groups
array of object - Name
string - Id
stringformat: uuid - Manager
string
- Location
string - Notes
string - Lead
stringformat: uuid - AvatarMedium
string - Avatar
string - IsAdmin
boolean - IsLDAP
boolean - ListAdminModules
array of string - IsOwner
boolean - IsVisitor
boolean - CultureName
string - IsSSO
boolean - QuotaLimit
integerformat: int64 - UsedSpace
integerformat: int64 - DocsSpace
integerformat: int64 - MailSpace
integerformat: int64 - TalkSpace
integerformat: int64 - Id
stringformat: uuid - DisplayName
string - Title
string - AvatarSmall
string - ProfileUrl
string
401
Unauthorized