v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Groups

List org group memberships

List organization group memberships. Filter by org group ID or org UUID. At least one of filter[org_group_id] or filter[org_uuid] must be provided. When filtering by org UUID, returns a single-item list with the membership for that org.

get/api/v2/org_group_memberships

Query parameters

filter[org_group_id]string uuid

Example:a1b2c3d4-e5f6-7890-abcd-ef0123456789

Filter memberships by org group ID. Required when filter[org_uuid] is not provided.

filter[org_uuid]string uuid

Example:b2c3d4e5-f6a7-8901-bcde-f01234567890

Filter memberships by org UUID. Returns a single-item list.

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 memberships by.

Example:uuid

Field to sort memberships 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",
        "org_name": "Acme Corp",
        "org_site": "us1",
        "org_uuid": "c3d4e5f6-a7b8-9012-cdef-012345678901"
      },
      "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
      "relationships": {
        "org_group": {
          "data": {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef0123456789",
            "type": "org_groups"
          }
        }
      },
      "type": "org_group_memberships"
    }
  ],
  "meta": {
    "page": {
      "type": "number_size"
    }
  }
}