---
title: "List custom domains"
method: GET
path: "/api/v2/domains"
tags: ["Domains"]
---

# List custom domains

`GET /api/v2/domains`

Returns all custom domains configured for the workspace.

## Query parameters

- `limit` integer
- `starting_after` string, nullable

## Headers

- `X-API-KEY` string, nullable
- `Authorization` string, nullable
- `X-Workspace-Id` string, nullable

## Response `200`

Successful Response

- ListResponseCustomDomainResponse
  - `data` CustomDomainResponse[], required
    - `object` 'domain' — Object type identifier.
    - `id` string, required — Unique domain configuration identifier.
    - `domain` string, required — The custom domain name.
    - `cname_target` string, required — CNAME target for DNS configuration.
    - `status` string, required — Domain verification status: 'pending', 'active', 'error'.
    - `active` boolean, required — Whether the domain is verified and active for use.
    - `created_at` number, required — Unix timestamp when the domain was created.
    - `updated_at` number, required — Unix timestamp when the domain was last updated.
  - `pagination` PaginationMeta, required
    - `has_more` boolean, required — Whether more results exist beyond this page
    - `total_count` integer, nullable — Total number of results (if available)
    - `url` string, nullable — URL of this resource

## Other responses

- `401` — Invalid or missing API key.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/heymilo/apis/heymilo-public-api.md) · [All operations](https://skmtc.net/heymilo/apis/heymilo-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/heymilo/heymilo-public-api/revisions/5e07b657706b/schema)