ATathenahq
Groups

Get Group

Changed on

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), and every website object inside websites carries its own externalId (null when that website has no mapping), so sites can be matched by your own identifier instead of by URL.

get/api/v1/groups/{group_id}

Request

  • Base URL
    https://api.athenahq.ai
  • Auth
    API key in header x-api-key

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": "ws_a7f3b2c9"
      }
    ],
    "externalId": "acct_9e4c1b8d"
  }
}

Changes