Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Groups

List groups
groups.list(GroupListParams**kwargs) -> SyncPageNumberPage[Group]
GET/v1/groups
Create group
groups.create(GroupCreateParams**kwargs) -> GroupResponse
POST/v1/groups
Get group
groups.retrieve(strgroup_id) -> GroupResponse
GET/v1/groups/{group_id}
Update group
groups.update(strgroup_id, GroupUpdateParams**kwargs) -> GroupResponse
PATCH/v1/groups/{group_id}
ModelsExpand Collapse
class Group: …
id: str

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

created_at: Optional[datetime]

Group creation timestamp (ISO 8601, UTC).

formatdate-time
external_reference_id: str

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

maxLength255
name: str

Human-readable group name.

maxLength255
organization_id: str

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

updated_at: Optional[datetime]

Last-update timestamp (ISO 8601, UTC).

formatdate-time
class GroupResponse: …

Response containing a single group resource.

data: Group
id: str

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

created_at: Optional[datetime]

Group creation timestamp (ISO 8601, UTC).

formatdate-time
external_reference_id: str

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

maxLength255
name: str

Human-readable group name.

maxLength255
organization_id: str

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

updated_at: Optional[datetime]

Last-update timestamp (ISO 8601, UTC).

formatdate-time

GroupsMembers

GroupsMembersSync

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

Response containing a single group member sync detail resource.

data: Data
accepted_at: datetime
formatdate-time
group_id: str
request_id: str
class SyncRetrieveResponse: …

Response containing a single group member sync request detail resource.

data: Data
accepted_at: datetime
formatdate-time
completed_at: Optional[datetime]
formatdate-time
group_id: str
request_id: str
results: Optional[DataResults]
added_group_member_ids: List[str]
failures: List[DataResultsFailure]
operation: Literal["add", "remove"]
  • add - add
  • remove - remove
One of the following:
"add"
"remove"
reason: str
reference_id: str
removed_group_member_ids: List[str]