...
| Panel | ||
|---|---|---|
| ||
When requesting ListUsers, the values for the "Inactive" and "Employment Ended" statuses are the same — 3. To differentiate between these statuses, use the ListUsers/v2 request. In this way, in the status parameter, inactive users will be indicated by status 3, while users who are identified as "Employment Ended" will be indicated by status 5. |
...
| Parameter | Type | Description |
|---|---|---|
| token (required) | string | Access token. You can obtain a token by making a request |
| groupId (optional) | string | If this parameter is used, only users belonging to the specified group will be retrieved |
| departmentId (optional) | string | If this parameter is used, only users belonging to the specified department will be retrieved |
| pageSize (optional) | string | The number of entries per page. If not indicated, equal to 1000 |
| pageToken (optional) | string | The token needed to continue to the next page |
| logins (optional) | string | An array of logins whose users you want to retrieve |
| emails (optional) | string | An array of emails whose users you want to retrieve |
...
| Parameter | Type | Description |
|---|---|---|
| users | UserProfile[] | An array containing user profiles.The UserProfile object has the same properties as the getUserProfile method |
| nextPageToken | string | The token needed to continue to the next page |
| workLeaveStatus (optional) | string | A work leave status. An array with the following parameters:
|
...