---
title: "Get Websites"
method: GET
path: "/api/v1/websites"
tags: ["Basics"]
---

# Get Websites

`GET /api/v1/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.

## Query parameters

- `external_id` string

## Response `200`

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.

- object
  - `websites` Website[], required
    - `id` string, uuid, required — Unique identifier for the website
    - `websiteName` string, required — Display name of the website
    - `websiteUrl` string, required — The domain of the website (without protocol)
    - `onboardingStep` integer, nullable — Current onboarding step for the website. Null indicates onboarding is complete.
    - `externalId` string, nullable — **Partner-only.** The partner-supplied identifier mapped to this website. Only present on responses to callers whose organization is flagged as a partner. Direct-customer responses omit the field entirely. `null` indicates no mapping exists for this website.

## Other responses

- `401` — Unauthorized - Invalid or missing API key
- `403` — Forbidden - `external_id` is partner-only; non-partner API keys cannot use this filter.
- `500` — Internal server error

---

[API](https://skmtc.net/athenahq/apis/athenahq-api.md) · [All operations](https://skmtc.net/athenahq/apis/athenahq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/athenahq/athenahq-api/versions/6c5d71622cb9/schema)