---
title: "List custom domains."
method: GET
path: "/v1/domains"
tags: ["Domains"]
---

# List custom domains.

`GET /v1/domains`

## Request

- Base URL: `https://api.scalix.world`
- URL: `https://api.scalix.world/v1/domains`
- Auth: HTTP bearer

Returns all custom domains attached to the caller's project, with their
verification and SSL status.

## Response `200`

All custom domains for the caller's project

- ListDomainsResponse: Response for `GET /v1/domains` — all custom domains for the project.
  - `domains` DomainJson[], required
    - `id` string, required
    - `project_id` string, required
    - `domain` string, required
    - `domain_type` string, required
    - `status` string, required
    - `verification_token` string, required
    - `ssl_status` string, required
    - `ssl_expires_at` string, required
    - `ssl_issued_at` string, required
    - `ssl_error` string, nullable: Last cert-issuance failure reason (absent = none). Lets the console show "DNS doesn't point to our edge" instead of a silent stuck 'none'/'failed'.
    - `primary_domain` boolean, required
    - `created_at` string, required
    - `updated_at` string, required
    - `cname_target` string, nullable
    - `run_service` string, nullable: Run service this domain serves (absent = the project's API surface).
    - `storage_bucket` string, nullable
    - `function_name` string, nullable: Function this domain serves (absent = not a function target).
    - `edge_ip` string, nullable: Gateway IP for apex A-record setup (absent if not configured).

## Other responses

- `401`: Missing or invalid credentials
- `500`: Internal error

---

[API](https://skmtc.dev/scalix/apis/scalix-cloud-api.md) · [All operations](https://skmtc.dev/scalix/apis/scalix-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scalix/apis/scalix-cloud-api/revisions/2c04ca0a90bb?raw)