List groups

Returns a paginated list of groups, ten groups per page by default. Use the startIndex and count (max 100) query parameters to paginate long lists of groups. It's possible to return a list of specific types of groups using the filter parameter.

Request
query Parameters
count
integer <int32>

The number of records returned per page in the response.

filter
string

The filter used to filter the group, either by organization id.

startIndex
integer <int32>

The index number of the page that you want to retrieve. You must set count before specifying startIndex. For example, if you set count to 20 and startIndex to 2, the 21st to 40th records are returned in the response.

header Parameters
Authorization
required
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Content-Type
required
string

The Content-Type of the request must be application/json.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/scim/v2/Groups
Request samples
Response samples
application/json
{
  • "schemas": [
    ],
  • "id": null,
  • "externalId": null,
  • "meta": null,
  • "totalResults": 28,
  • "resources": [
    ]
}