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": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "members": [
        {
          "value": "<string>",
          "display": "<string>"
        }
      ],
      "meta": {
        "resourceType": "Group",
        "created": "2023-11-07T05:31:56Z",
        "lastModified": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "itemsPerPage": 123,
  "startIndex": 123,
  "totalResults": 123
}

Authorizations

Authorization
string
header
required

Use either an Organization API Key or Personal Access Token (PAT). Include in the Authorization header as: Bearer YOUR_TOKEN

Query Parameters

count
integer
default:100

Number of results per page

startIndex
integer
default:1

Starting index for pagination

Response

List of user groups

Resources
object[]
itemsPerPage
integer
startIndex
integer
totalResults
integer