Workspaces

Get a domain

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

GET
/v1/domains/{id}

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

Path Parameters

idstringrequired

The domain's domain_id.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/domains/string"
{  "domain_id": "3f2b8c1e-5d6a-4a39-9c1e-0a7e2f6d4b11",  "slug": "leases",  "display_name": "Leases",  "owner": "tenant",  "version": 1,  "status": "draft",  "parent_slug": null,  "class_count": 1,  "selectable": false,  "taxonomy": {    "classes": [      {        "group": "leases",        "subgroup": "amendments",        "description": "Amendments to a signed lease.",        "aliases": [          "lease amendment"        ]      }    ],    "allow_other": true  },  "published_at": null}