Skip to main content
GET
/
api
/
v1
/
websites
Get Websites
curl --request GET \
  --url https://api.athenahq.ai/api/v1/websites \
  --header 'x-api-key: <api-key>'
{
  "websites": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "websiteName": "My Awesome Blog",
      "websiteUrl": "example.com",
      "onboardingStep": null,
      "externalId": "ws_a7f3b2c9"
    }
  ]
}

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 website 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 websites. Partner responses include an externalId field on each item (string or null); direct-customer responses omit the field entirely.

​
websites
object[]
required