v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Groups

List org groups

List all organization groups that the requesting organization has access to.

get/api/v2/org_groups

Query parameters

page[number]integer

The page number to return.

page[size]integer

Example:50

The number of items per page. Maximum is 1000.

sort'name' | '-name' | 'uuid' | '-uuid'

Field to sort org groups by.

Example:name

Field to sort org groups by. Supported values: name, uuid, -name, -uuid. Defaults to uuid.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "created_at": "2024-01-15T10:30:00Z",
        "modified_at": "2024-01-15T10:30:00Z",
        "name": "My Org Group",
        "owner_org_site": "us1",
        "owner_org_uuid": "b2c3d4e5-f6a7-8901-bcde-f01234567890"
      },
      "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
      "type": "org_groups"
    }
  ],
  "meta": {
    "page": {
      "type": "number_size"
    }
  }
}