user:read:admin
Rate Limit Label: Medium.
External DocumentationTo learn more, visit the Zoom documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Include Fields | 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. |
| Page Size | The number of records returned within a single API call. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Role ID | 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. |
| Status | The user’s status: * active — An active user. * inactive — A deactivated user. * pending — A pending user.This value defaults to active. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Next Page Token | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
| Page Number | The page number of the current page in the returned records. |
Example Output
{
"page_count": 2,
"page_number": 2,
"page_size": 14,
"total_records": 5,
"next_page_token": "<string>",
"users": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"email": "<string>",
"type": 6,
"timezone": "<string>",
"verified": 0,
"dept": "<string>",
"created_at": "2020-04-01T16:47:52Z",
"pic_url": "<string>",
"group_ids": [
"<string>"
],
"language": "<string>",
"phone_number": "<string>",
"status": "<string>",
"role_id": "<string>",
"employee_unique_id": "<string>",
"user_created_at": "2020-04-01T16:47:52Z",
},
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"email": "<string>",
"type": 0,
"pmi": 2,
"verified": 1,
"dept": "<string>",
"created_at": "2020-04-01T16:47:52Z",
"language": "<string>",
"status": "<string>",
"role_id": "<string>",
"employee_unique_id": "<string>",
"user_created_at": "2020-04-01T16:47:52Z",
}
]
}