> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/outbound-site/openapi.json](/docs/api/outbound-site/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Outbound domain pages: Get a domain's website

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

One endpoint of [Outbound domain pages](/docs/api/outbound-site.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## Get a domain's website

`GET /v1/domains/{domainId}/website` - operationId `outbound-site.domain-get`

| Permission | Rate limit |
| --- | --- |
| Delivery view | 12,000 requests a minute per API key |

Returns what a visitor sees on this domain: the domain's website choice and, for each hostname, whether Kenso
serves the workspace's outbound site page there.

`mode` is `unset` (nobody chose yet, so the domain keeps sending visitors to its forwarding URL),
`redirect` or `page`. Change it with `websiteMode` on `PATCH /v1/domains/{domainId}`.
`hostnames` lists the bare domain first, then its `www` hostname, and is empty until Kenso has checked
the domain.

Errors:

- `404 not_found`: the workspace has no domain with this id.

Requires Delivery view.

Needs the `domain_pages` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/domains/GET/v1/domains/%7BdomainId%7D/website)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `domainId` | path | integer (int64) | yes | The domain's id. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a `DomainWebsite`.

| Field | Type | Description |
| --- | --- | --- |
| `domainId` | integer (int64) | The domain's id. |
| `mode` | string | The domain's website choice: `unset` (nobody chose yet, so the domain keeps sending visitors to its forwarding URL), `redirect` or `page`. |
| `currentVersionId` | integer (int64) | Id of the outbound site page version the workspace serves now. Omitted until a page was published. |
| `hostnames` | array of DomainWebsiteHostname | The domain's hostnames: the bare domain first, then its `www` hostname. Empty until Kenso has checked the domain. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/domains/812/website" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": {
    "domainId": 812,
    "mode": "string",
    "currentVersionId": 812,
    "hostnames": [
      {
        "hostname": "acme-mail.com",
        "attachPath": "worker_route",
        "dnsWriter": "string",
        "dnsWriterKind": "string",
        "status": "string",
        "sslStatus": "active",
        "unsupportedReason": "string",
        "checkedAt": "2026-09-23T15:02:11Z",
        "lastError": "string",
        "stopped": true
      }
    ]
  }
}
```

## Types

Each named type the tables above use, nested ones included.

### DomainWebsiteHostname

Whether Kenso serves the outbound site page on one hostname of a domain.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `hostname` | string | no | The hostname, such as `acme-mail.com` or `www.acme-mail.com`. |
| `attachPath` | string | no | How Kenso serves the page on this hostname: `worker_route` or `custom_hostname`. Omitted when the hostname cannot show the page; `unsupportedReason` says why. |
| `dnsWriter` | string | no | The DNS host through which Kenso writes this hostname's records, as a code for Kenso's DNS, the mailbox provider or the registrar. Omitted when Kenso cannot write them. Prefer dnsWriterKind. |
| `dnsWriterKind` | string | no | Who writes this hostname's DNS records, in neutral words: `kenso` when Kenso writes them (through Kenso's DNS, the mailbox provider or the registrar), or `other`. Omitted when Kenso cannot write them. |
| `status` | string | no | Whether the page is on this hostname: `detached` (not served), `attaching`, `active` (served), `detaching` or `failed`. |
| `sslStatus` | string | no | State of the hostname's SSL certificate as Kenso's edge reports it, such as `active`. Only set for `custom_hostname`; omitted otherwise. |
| `unsupportedReason` | string | no | Why this hostname cannot show the page: `unknown_dns_host` (Kenso cannot write the domain's DNS), `dns_lookup_failed`, `smtp_farm_apex` (the domain points at a mail server and needs a manual check) or `foreign_link_host` (the hostname serves another workspace's links). Omitted when it can show the page. |
| `checkedAt` | string (date-time) | no | When Kenso last checked or changed this hostname, in UTC. Omitted before the first check. |
| `lastError` | string | no | Why Kenso's last attempt to put the page on this hostname, or take it off, failed: one short fixed sentence with no trailing period. Omitted when the last attempt did not fail. |
| `stopped` | boolean | no | True when Kenso stopped retrying after repeated failures. It starts again when the domain's website choice or its DNS changes: switching the domain to `redirect` and back restarts it. |
