List users
GET {{baseUrl}}/users?status=active&page_size=30&role_id=<string>&page_number=<string>&include_fields=host_key&next_page_token=<string>&license=zoom_workforce_management
Retrieve a list your account's users.
Scopes:
user:read:admin
Rate Limit Label
:
MEDIUM
Request Params
| Key | Datatype | Required | Description |
| status | string | | The user's status.
active- The user exists on the account.inactive- The user has been deactivated.pending- The user exists on the account, but has not activated their account. See Managing users for details.
This value defaults to active. |
| page_size | number | | The number of records returned within a single API call. |
| role_id | string | | The role's unique ID. Use this parameter to filter the response by a specific role. You can use the List roles API to get a role's unique ID value. |
| page_number | string | | The page number of the current page in the returned records. |
| include_fields | string | | Use this parameter to display one of the following attributes in the API call's response:
custom_attributes— Return the user's custom attributes.host_key— Return the user's host key. | |next_page_token| string | | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |license| string | | The user's license. Filter the response by a specific license. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_number":1,"page_size":30,"total_records":"\u003cinteger\u003e","users":[{"email":"\u003cemail\u003e","type":2,"user_created_at":"\u003cdateTime\u003e","created_at":"\u003cdateTime\u003e","custom_attributes":[{"key":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"dept":"\u003cstring\u003e","employee_unique_id":"\u003cstring\u003e","first_name":"\u003cstring\u003e","group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"host_key":"\u003cstring\u003e","id":"\u003cstring\u003e","im_group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"last_client_version":"\u003cstring\u003e","last_login_time":"\u003cdateTime\u003e","last_name":"\u003cstring\u003e","plan_united_type":"128","pmi":"\u003clong\u003e","role_id":"\u003cstring\u003e","status":"inactive","timezone":"\u003cstring\u003e","verified":1,"display_name":"\u003cstring\u003e"},{"email":"\u003cemail\u003e","type":1,"user_created_at":"\u003cdateTime\u003e","created_at":"\u003cdateTime\u003e","custom_attributes":[{"key":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"dept":"\u003cstring\u003e","employee_unique_id":"\u003cstring\u003e","first_name":"\u003cstring\u003e","group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"host_key":"\u003cstring\u003e","id":"\u003cstring\u003e","im_group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"last_client_version":"\u003cstring\u003e","last_login_time":"\u003cdateTime\u003e","last_name":"\u003cstring\u003e","plan_united_type":"256","pmi":"\u003clong\u003e","role_id":"\u003cstring\u003e","status":"active","timezone":"\u003cstring\u003e","verified":1,"display_name":"\u003cstring\u003e"}]}