NAnace
Domains

Get a domain

One domain version with its taxonomy, inheritance resolved. Free.

get/v1/domains/{id}

Request

Path parameters

idstring required

The domain's domain_id.

Response

The domain.

domain_idstring required
slugstring required
display_namestring required
owner'platform' | 'tenant' required

platform for the ones every account sees, tenant for the account's own.

versioninteger required
status'draft' | 'published' required
parent_slugstring nullable required

The domain this one inherits from, or null.

class_countinteger required
selectableboolean required

True once published: only then can a new workspace pin it.

published_atstring nullable required

ISO 8601 timestamp, or null for a draft.

Example response

{
  "taxonomy": {
    "classes": [
      {
        "group": "leases",
        "subgroup": "amendments",
        "description": "Amendments to a signed lease.",
        "aliases": [
          "lease amendment"
        ]
      }
    ],
    "allow_other": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.