Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Groups

List groups
client.groups.list(GroupListParams { limit, page } query?, RequestOptionsoptions?): PageNumberPage<Group { id, created_at, external_reference_id, 3 more } >
GET/v1/groups
Create group
client.groups.create(GroupCreateParams { external_reference_id, name } body, RequestOptionsoptions?): GroupResponse { data }
POST/v1/groups
Get group
client.groups.retrieve(stringgroupID, RequestOptionsoptions?): GroupResponse { data }
GET/v1/groups/{group_id}
Update group
client.groups.update(stringgroupID, GroupUpdateParams { external_reference_id, name } body?, RequestOptionsoptions?): GroupResponse { data }
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 | null

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 | null

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 | null

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 | null

Last-update timestamp (ISO 8601, UTC).

formatdate-time

GroupsMembers

GroupsMembersSync

Submit group member sync
client.groups.members.sync.submit(stringgroupID, SyncSubmitParams { members } body, RequestOptionsoptions?): SyncSubmitResponse { data }
POST/v1/groups/{group_id}/members/sync
Get group member sync request
client.groups.members.sync.retrieve(stringrequestID, SyncRetrieveParams { group_id } params, RequestOptionsoptions?): SyncRetrieveResponse { data }
GET/v1/groups/{group_id}/members/sync/{request_id}
ModelsExpand Collapse
SyncSubmitResponse { data }

Response containing a single group member sync detail resource.

data: 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: Data { accepted_at, completed_at, group_id, 2 more }
accepted_at: string
formatdate-time
completed_at: string | null
formatdate-time
group_id: string
request_id: string
results: Results | null
added_group_member_ids: Array<string>
failures: Array<Failure>
operation: "add" | "remove"
  • add - add
  • remove - remove
One of the following:
"add"
"remove"
reason: string
reference_id: string
removed_group_member_ids: Array<string>