v1

latestOpenAPI 3.1.02026-07-2295105298.6 KB

Basics

Get Websites

Returns all active websites associated with your API key. Partner integrations may pass external_id as a query parameter to find the Athena website mapped to a partner-supplied identifier.

get/api/v1/websites

Query parameters

external_idstring

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.

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.

Example response

{
  "websites": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "websiteName": "My Awesome Blog",
      "websiteUrl": "example.com",
      "externalId": "ws_a7f3b2c9"
    }
  ]
}