Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Groups

List groups

groups.list(GroupListParams**kwargs) -> SyncPageNumberPage[Group]
GET/v1/groups

Returns a paginated list of groups belonging to the authenticated organization.

ParametersExpand Collapse
limit: Optional[int]

Items per page (default: 20, max: 100)

minimum1
maximum100
page: Optional[int]

Page number (default: 1)

minimum1
ReturnsExpand 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

List groups

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
page = client.groups.list()
page = page.data[0]
print(page.id)
{
  "data": [
    {
      "id": "grp_abc123def456",
      "organization_id": "org_abc123def456",
      "name": "Tier 1",
      "external_reference_id": "mol_seg_001",
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}
Returns Examples
{
  "data": [
    {
      "id": "grp_abc123def456",
      "organization_id": "org_abc123def456",
      "name": "Tier 1",
      "external_reference_id": "mol_seg_001",
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}