Skip to main content
GET
Read the taxonomy

Authorizations

Authorization
string
header
required

An Agent credential (nits_…), or a person token (nitp_…) on a deployment that enables them. GET /api/v1/session names the principal a credential proves.

Query Parameters

projectId
string
required
Required string length: 1 - 200
branchId
string
required
Required string length: 1 - 200

Response

Read the taxonomy

definition
object | null
required

Category, field and group ids are unique; a category's parentId names another declared category and parent chains do not cycle; every fieldIds entry names a declared field; a category's groupId names a declared group, a position needs a groupId, and positions are unique within a group. groups is absent rather than empty.

taxonomyVersion
string | null
required