List groups

GET/v1/groups

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

Query ParametersExpand Collapse

limit: optional number

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

minimum1

maximum100

page: optional number

Page number (default: 1)

minimum1

ReturnsExpand Collapse

data: array of 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

pagination: Pagination { limit, page, total, total_pages }

Pagination metadata for list responses.

limit: number

Items per page

page: number

Current page number

total: number

Total number of items

total_pages: number

Total number of pages

List groups

curl https://api.vitablehealth.com/v1/groups \
    -H "Authorization: Bearer $VITABLE_CONNECT_API_KEY"

{
  "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
  }
}