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
Request Params
| 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":["\u003cstring\u003e","\u003cstring\u003e"],"totalResults":"\u003cinteger\u003e","startIndex":"\u003cinteger\u003e","itemsPerPage":"\u003cinteger\u003e","Resources":[{"id":"\u003cstring\u003e","meta":{"resourceType":"\u003cstring\u003e"},"schemas":["\u003cstring\u003e","\u003cstring\u003e"],"displayName":"\u003cstring\u003e","urn:ietf:params:scim:schemas:extension:zoom:2.0:Group":{"emailAlias":"\u003cstring\u003e"}},{"id":"\u003cstring\u003e","meta":{"resourceType":"\u003cstring\u003e"},"schemas":["\u003cstring\u003e","\u003cstring\u003e"],"displayName":"\u003cstring\u003e","urn:ietf:params:scim:schemas:extension:zoom:2.0:Group":{"emailAlias":"\u003cstring\u003e"}}]}