Skip to main content
GET
/
scim
/
v2
/
groups
List user groups
curl --request GET \
  --url https://{instance}.omniapp.co/api/scim/v2/groups \
  --header 'Authorization: Bearer <token>'
{
  "Resources": [
    {
      "displayName": "Blob Sales",
      "id": "mEhXj6ZI",
      "meta": {
        "created": "2024-08-29T20:33:36.626Z",
        "lastModified": "2024-08-29T20:33:36.626Z",
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "members": [
        {
          "display": "[email protected]",
          "value": "9e8719d9-276a-4964-9395-a493189a247c"
        }
      ]
    }
  ],
  "itemsPerPage": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 1
}

Authorizations

​
Authorization
string
header
required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Query Parameters

​
count
integer
default:100

The number of groups to return

​
startIndex
integer
default:1

An integer index that determines the starting point of the sorted result list

Response

List of user groups

​
Resources
object[]

The list of user groups

​
schemas
string[]

SCIM schema information for the response

​
itemsPerPage
integer

The number of groups returned in the current page

​
startIndex
integer

The starting index of the current page in the result set

​
totalResults
integer

The total number of groups matching the query