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}

Get Group

cURL

curl --request GET \
  --url https://api.athenahq.ai/api/v1/groups/{group_id} \
  --header 'x-api-key: <api-key>'

200

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

Authorizations

x-api-key · string · header · required

API key for authentication. You can create one here.

Path Parameters

group_id · string<uuid> · required

The unique identifier of the group

Response

200

application/json

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

group · object · required

A group of websites in your organization

Show child attributes