Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Groups

List groups
groups.list(**kwargs) -> PageNumberPage<Group { id, created_at, external_reference_id, 3 more } >
GET/v1/groups
Create group
groups.create(**kwargs) -> GroupResponse { data }
POST/v1/groups
Get group
groups.retrieve(group_id) -> GroupResponse { data }
GET/v1/groups/{group_id}
Update group
groups.update(group_id, **kwargs) -> GroupResponse { data }
PATCH/v1/groups/{group_id}
ModelsExpand Collapse
class Group { id, created_at, external_reference_id, 3 more }
id: String

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

created_at: Time

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: Time

Last-update timestamp (ISO 8601, UTC).

formatdate-time
class 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: Time

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: Time

Last-update timestamp (ISO 8601, UTC).

formatdate-time

GroupsMembers

GroupsMembersSync

Submit group member sync
groups.members.sync.submit(group_id, **kwargs) -> SyncSubmitResponse { data }
POST/v1/groups/{group_id}/members/sync
Get group member sync request
groups.members.sync.retrieve(request_id, **kwargs) -> SyncRetrieveResponse { data }
GET/v1/groups/{group_id}/members/sync/{request_id}
ModelsExpand Collapse
class SyncSubmitResponse { data }

Response containing a single group member sync detail resource.

data: { accepted_at, group_id, request_id}
accepted_at: Time
formatdate-time
group_id: String
request_id: String
class SyncRetrieveResponse { data }

Response containing a single group member sync request detail resource.

data: { accepted_at, completed_at, group_id, 2 more}
accepted_at: Time
formatdate-time
completed_at: Time
formatdate-time
group_id: String
request_id: String
results: { added_group_member_ids, failures, removed_group_member_ids}
added_group_member_ids: Array[String]
failures: Array[{ operation, reason, reference_id}]
operation: :add | :remove
  • add - add
  • remove - remove
One of the following:
:add
:remove
reason: String
reference_id: String
removed_group_member_ids: Array[String]