---
title: "List the custom domains of a workspace"
method: GET
path: "/account/domains"
---

# List the custom domains of a workspace

`GET /account/domains`

## Request

- Base URL: `https://api.eurobase.dev`
- URL: `https://api.eurobase.dev/account/domains`
- Auth: none declared

The workspace owner sees every domain of the workspace; a project member sees the domains linked to their projects. Each domain names the project it serves, if any, lists the two DNS records to add where the domain DNS lives, and shows what public DNS reports.

## Query parameters

- `organizationId` string, required

## Response `200`

Workspace domains

- WorkspaceDomainsResponse
  - `canManage` boolean, required: Whether the caller owns the workspace and so adds, links, unlinks and removes its domains
  - `linkableProjects` object[], required: Workspace projects a domain can be linked to; empty unless the caller owns the workspace
    - `id` string, required
    - `name` string, required
    - `hostname` string, nullable, required
    - `repoFullName` string, nullable, required
    - `branch` string, nullable, required
  - `used` integer, required: Domains the workspace has, linked or not; the limit applies to this count
  - `domains` object[], required
    - `id` string, required
    - `hostname` string, required
    - `status` 'pending' | 'issuing' | 'active' | 'failed', required
    - `statusReason` 'verification_timeout' | 'certificate_failed' | 'challenge_record_missing' | 'challenge_record_removed' | 'null', nullable, required
    - `records` object[], required: The records to add, each with what public DNS shows. A zone apex also lists its www companion (_acme-challenge.www and www), which redirects to the apex.
      - `type` 'CNAME' | 'A', required
      - `name` string, required: Fully qualified record name
      - `host` string, nullable, required: Record name relative to the domain DNS zone (@ for the zone itself); null until the zone is known
      - `value` string, nullable, required: Null only while custom domains are unavailable
      - `purpose` 'verification' | 'traffic', required
      - `state` 'ok' | 'waiting' | 'elsewhere', required: elsewhere: a traffic record that resolves to an address other than the edge
      - `observed` string[]
      - `aliasValue` string: For an A record: the hostname an ALIAS, ANAME or flattened CNAME may point to instead
      - `acceptedValue` string: For the www record of a zone apex: the apex, which the CNAME may point to instead
    - `zone` string, nullable, required: The DNS zone the domain lives in, once public DNS shows it
    - `dnsTargetState` 'unknown' | 'ok' | 'elsewhere' | 'missing', required
    - `certificateState` 'waiting' | 'issuing' | 'issued', required
    - `www` object, nullable, required: A zone apex only: its www companion, which redirects to the apex while the apex certificate covers it. requested: being added to the certificate; issued: covered; failing: covered but not renewing; failed: not covered within 24 hours, so it was removed and the apex renews alone.
      - `name` string, required
      - `certificateState` 'none' | 'requested' | 'issued' | 'failing' | 'failed', required
    - `converging` boolean, required: The domain will change state without anyone acting (pending or issuing)
    - `checkedAt` string, date-time, nullable, required
    - `activeAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `project` object, nullable, required: The project the domain serves; null while it is not linked
      - `id` string, required
      - `name` string, required
      - `hostname` string, nullable, required: The project production hostname the domain serves
      - `repoFullName` string, nullable, required
      - `branch` string, nullable, required
  - `availability` 'available' | 'unavailable', required
  - `limit` integer, required: Domains this workspace may have: 1 on Free, 10 on paid plans

## Other responses

- `400`: organizationId missing (organization-id-required)
- `404`: Not a member of this workspace (workspace-not-found)

---

[API](https://skmtc.dev/eurobase/apis/eurobase-api.md) · [All operations](https://skmtc.dev/eurobase/apis/eurobase-api/llms.txt) · [OpenAPI document](https://skmtc.dev/eurobase/apis/eurobase-api/revisions/5266a299d18a?raw)