List groups

client.groups.list(?, ?): PageNumberPage<Group { id, created_at, external_reference_id, 3 more } >

GET/v1/groups

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

ParametersExpand Collapse

query: GroupListParams { limit, page }

limit?: number

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

minimum1

maximum100

page?: number

Page number (default: 1)

minimum1

ReturnsExpand 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

List groups

import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const group of client.groups.list()) {
  console.log(group.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
  }
}