Groups

List groups

GET/v1/groups

Create group

POST/v1/groups

Get group

GET/v1/groups/{group_id}

Update group

PATCH/v1/groups/{group_id}

ModelsExpand Collapse

Group { id, created_at, external_reference_id, 3 more }

id: string

Prefixed group identifier (grp_<base64-encoded-uuid>).

created_at: string

Group creation timestamp (ISO 8601, UTC).

formatdate-time

external_reference_id: string

Stable identifier for this group in the integrator’s own system.

maxLength255

name: string

Human-readable group name.

maxLength255

organization_id: string

Prefixed organization identifier (org_<base64-encoded-uuid>).

updated_at: string

Last-update timestamp (ISO 8601, UTC).

formatdate-time

GroupResponse { data }

Response containing a single group resource.

data: Group { id, created_at, external_reference_id, 3 more }

id: string

Prefixed group identifier (grp_<base64-encoded-uuid>).

created_at: string

Group creation timestamp (ISO 8601, UTC).

formatdate-time

external_reference_id: string

Stable identifier for this group in the integrator’s own system.

maxLength255

name: string

Human-readable group name.

maxLength255

organization_id: string

Prefixed organization identifier (org_<base64-encoded-uuid>).

updated_at: string

Last-update timestamp (ISO 8601, UTC).

formatdate-time

GroupsMembers

GroupsMembersSync

Submit group member sync

POST/v1/groups/{group_id}/members/sync

Get group member sync request

GET/v1/groups/{group_id}/members/sync/{request_id}

ModelsExpand Collapse

SyncSubmitResponse { data }

Response containing a single group member sync detail resource.

data: { accepted_at, group_id, request_id }

accepted_at: string

formatdate-time

group_id: string

request_id: string

SyncRetrieveResponse { data }

Response containing a single group member sync request detail resource.

data: { accepted_at, completed_at, group_id, 2 more }

accepted_at: string

formatdate-time

completed_at: string

formatdate-time

group_id: string

request_id: string

results: { added_group_member_ids, failures, removed_group_member_ids }

added_group_member_ids: array of string

failures: array of { operation, reason, reference_id }

operation: "add" or "remove"

add - add
remove - remove

One of the following:

"add"

"remove"

reason: string

reference_id: string

removed_group_member_ids: array of string