ATathenahq
Groups

List Groups

Changed on

Returns all groups for your organization, including associated websites. Requires a global API key. Partner integrations may pass external_id as a query parameter to find the Athena group mapped to a partner-supplied identifier. Partner responses additionally include externalId on each group and on every website object inside websites (null when no mapping exists), so sites can be matched by your own identifier instead of by URL.

get/api/v1/groups

Request

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

Query parameters

external_idstring

Partner-only. Filter results to the group mapped to this partner-supplied identifier. Accepted only when authenticating with a partner API key — direct customers that pass this parameter receive 403 Forbidden. Exact match, scoped to your organization; unmapped IDs return an empty array.

Response

Successful response with list of groups. Partner responses include an externalId field on each item (string or null); direct-customer responses omit the field entirely.

Example response

{
  "groups": [
    {
      "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

  • 2d1d86d5e067Revision changes
    • info

      added the optional property //// to the response with the status