v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB

Groups

Get Group

Returns a single group by ID, including associated websites. Requires a global API key. Partner integrations additionally receive an externalId field populated from the partner mapping (if any).

get/api/v1/groups/{group_id}

Response

Successful response with the group. Partner responses include an externalId field (string or null); direct-customer responses omit the field entirely.

Example response

{
  "group": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Enterprise Clients",
    "orgId": "987e6543-e21b-12d3-a456-426614174000",
    "createdAt": "2024-06-15T10:30:00.000Z",
    "websites": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "websiteUrl": "example.com",
        "websiteName": "My Awesome Blog"
      }
    ],
    "externalId": "acct_9e4c1b8d"
  }
}