Workspaces

List domains

Other errors (500, 502, 503) are on Errors.

GET
/v1/domains

Other errors (500, 502, 503) are on Errors.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer nace_sk_...

  • Where: the dashboard's API Keys page. It is shown once, when you create it.
  • Format: nace_sk_ followed by 43 URL-safe characters (A-Z, a-z, 0-9, _ and -).
  • Limit: an account can hold at most 3 active keys.
  • Wrong or missing key: returns 401 authentication_error.

In: header

Query Parameters

ownerstring

Keep the platform's or the account's own.

Value in"platform""tenant"
statusstring

Keep drafts or published versions.

Value in"draft""published"
slugstring

Keep the versions of this slug.

limitinteger
Range1 <= value <= 200
Default50
cursorstring

next_cursor from the previous page.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/domains"
{  "items": [    {      "domain_id": "string",      "slug": "string",      "display_name": "string",      "owner": "platform",      "version": 1,      "status": "draft",      "parent_slug": "string",      "class_count": 0,      "selectable": true    }  ],  "next_cursor": "string",  "total_count": 0}