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
Request Params
| 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":["\u003cstring\u003e","\u003cstring\u003e"],"totalResults":"\u003cinteger\u003e","startIndex":"\u003cinteger\u003e","itemsPerPage":"\u003cinteger\u003e","Resources":[{"id":"\u003cstring\u003e","meta":{"resourceType":"\u003cstring\u003e","location":"\u003cstring\u003e","version":"\u003cstring\u003e"},"schemas":["\u003cstring\u003e","\u003cstring\u003e"],"name":{"givenName":"\u003cstring\u003e","familyName":"\u003cstring\u003e"},"emails":[{"type":"\u003cstring\u003e","value":"\u003cemail\u003e","primary":"\u003cboolean\u003e"},{"type":"\u003cstring\u003e","value":"\u003cemail\u003e","primary":"\u003cboolean\u003e"}],"displayName":"\u003cstring\u003e","userName":"\u003cemail\u003e","active":"\u003cboolean\u003e","userType":"Licensed","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"department":"\u003cstring\u003e"},"urn:us:zoom:scim:schemas:extension:1.0:ZoomUser":{"loginType":{"workEmail":"\u003cboolean\u003e","sso":"\u003cboolean\u003e"}}},{"id":"\u003cstring\u003e","meta":{"resourceType":"\u003cstring\u003e","location":"\u003cstring\u003e","version":"\u003cstring\u003e"},"schemas":["\u003cstring\u003e","\u003cstring\u003e"],"name":{"givenName":"\u003cstring\u003e","familyName":"\u003cstring\u003e"},"emails":[{"type":"\u003cstring\u003e","value":"\u003cemail\u003e","primary":"\u003cboolean\u003e"},{"type":"\u003cstring\u003e","value":"\u003cemail\u003e","primary":"\u003cboolean\u003e"}],"displayName":"\u003cstring\u003e","userName":"\u003cemail\u003e","active":"\u003cboolean\u003e","userType":"Licensed","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"department":"\u003cstring\u003e"},"urn:us:zoom:scim:schemas:extension:1.0:ZoomUser":{"loginType":{"workEmail":"\u003cboolean\u003e","sso":"\u003cboolean\u003e"}}}]}