Logo
Zoom Public API Documentation

List groups

GET {{baseUrl}}/scim2/Groups?startIndex=1&count=1&filter=<string>

Use this API to list all groups. 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 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: * `displayName eq {groupName}` — Provide the group's name to filter the response to a specific group.



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>" }, "schemas": [ "<string>", "<string>" ], "displayName": "<string>", "urn:ietf:params:scim:schemas:extension:zoom:2.0:Group": { "emailAlias": "<string>" } }, { "id": "<string>", "meta": { "resourceType": "<string>" }, "schemas": [ "<string>", "<string>" ], "displayName": "<string>", "urn:ietf:params:scim:schemas:extension:zoom:2.0:Group": { "emailAlias": "<string>" } } ] }



Curl
curl -X GET 'https://api.zoom.us/scim2/Groups?startIndex=1&count=1&filter=<string>?startIndex=1&count=1&filter=<string>' -H 'Accept: application/scim+json'

ENDPOINTS