Zoom Public API Documentation
List users
GET {{baseUrl}}/scim2/Users?startIndex=1&count=1&filter=<string>
Use this API to list all users. You can include additional query parameters to filter the response. OAuth Scope: scim2 Rate Limit Label: Medium
Body
PARAM
| Key | Datatype | Required | Description |
startIndex
|
number | (Required) The start index of records to be returned. | |
count
|
number | The number of records returned in a single API call. | |
filter
|
string | The type of query: * `userName eq {userEmail}` — Provide the user's email address to filter the response to a specific user. * `license type` — Filter the response by license type. * `externalId eq {userId}` — Filter the response by the user's ID (`userId`). |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"schemas": [
"<string>",
"<string>"
],
"totalResults": "<integer>",
"startIndex": "<integer>",
"itemsPerPage": "<integer>",
"Resources": [
{
"id": "<string>",
"meta": {
"resourceType": "<string>",
"location": "<string>",
"version": "<string>"
},
"schemas": [
"<string>",
"<string>"
],
"name": {
"givenName": "<string>",
"familyName": "<string>"
},
"emails": [
{
"type": "<string>",
"value": "<email>",
"primary": "<boolean>"
},
{
"type": "<string>",
"value": "<email>",
"primary": "<boolean>"
}
],
"displayName": "<string>",
"userName": "<email>",
"active": "<boolean>",
"userType": "Licensed",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "<string>"
},
"urn:us:zoom:scim:schemas:extension:1.0:ZoomUser": {
"loginType": {
"workEmail": "<boolean>",
"sso": "<boolean>"
}
}
},
{
"id": "<string>",
"meta": {
"resourceType": "<string>",
"location": "<string>",
"version": "<string>"
},
"schemas": [
"<string>",
"<string>"
],
"name": {
"givenName": "<string>",
"familyName": "<string>"
},
"emails": [
{
"type": "<string>",
"value": "<email>",
"primary": "<boolean>"
},
{
"type": "<string>",
"value": "<email>",
"primary": "<boolean>"
}
],
"displayName": "<string>",
"userName": "<email>",
"active": "<boolean>",
"userType": "Licensed",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "<string>"
},
"urn:us:zoom:scim:schemas:extension:1.0:ZoomUser": {
"loginType": {
"workEmail": "<boolean>",
"sso": "<boolean>"
}
}
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/scim2/Users?startIndex=1&count=1&filter=<string>?startIndex=1&count=1&filter=<string>' -H 'Accept: application/scim+json'
ENDPOINTS