Skip to main content
GET
/
api
/
v1
/
groups
List Groups
curl --request GET \
  --url https://api.athenahq.ai/api/v1/groups \
  --header 'x-api-key: <api-key>'
{
  "groups": [
    {
      "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.athenahq.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. You can create one here.

Query Parameters

​
external_id
string

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.

Minimum string length: 1

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.

​
groups
object[]
required