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

# List domains

`GET /v1/domains`

## Request

- Base URL: `https://console.nace.ai`
- URL: `https://console.nace.ai/v1/domains`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nace/apis/drex-api/docs/v1/domains/get.ts> (a function with typed inputs; its response is checked against the schema)

The domains this key's account sees: the platform's and its own, every version. Only a published version can be given to a new workspace as `domain`. Free.

## Query parameters

- `owner` 'platform' | 'tenant'
- `status` 'draft' | 'published'
- `slug` string
- `limit` integer
- `cursor` string

## Response `200`

One page of domains.

- DomainList
  - `items` DomainSummary[], required
    - `domain_id` string, required
    - `slug` string, required
    - `display_name` string, required
    - `owner` 'platform' | 'tenant', required: `platform` for the ones every account sees, `tenant` for the account's own.
    - `version` integer, required
    - `status` 'draft' | 'published', required
    - `parent_slug` string, nullable, required: The domain this one inherits from, or null.
    - `class_count` integer, required
    - `selectable` boolean, required: True once published: only then can a new workspace pin it.
  - `next_cursor` string, nullable, required: Pass as `cursor` for the next page; null on the last.
  - `total_count` integer, required

## Other responses

- `401`: Missing or invalid API key (`authentication_error`, code `invalid_api_key`).
- `404`: Domains are off on this deployment (`not_found`).
- `422`: A query parameter is invalid (`invalid_request_error`).
- `429`: Over the account's requests per minute for document routes (`rate_limit_error`).
- `500`: Something failed on Drex's side (`internal_error`).
- `502`: The document service refused Drex's own request (`upstream_error`, code `ndi_refused_drex`). Retry later.
- `503`: The document service is unavailable (`service_unavailable`).

---

[API](https://skmtc.dev/nace/apis/drex-api.md) - [All operations](https://skmtc.dev/nace/apis/drex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nace/apis/drex-api/revisions/a0e62d925a61?raw)