Get Database Taxonomy Tree

Returns the single-parent taxonomy structure tree.

A taxonomy is a hierarchical set of terms (categories, tags) you can attach to records.

This endpoint returns a single database taxonomy tree by id.

Returns the single-parent taxonomy structure tree

get

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Query parameters

IncludeTermsbooleanOptional

When true, each taxonomy node also carries its own term tree (heavier response).

DatabaseIntegrationIdstring · nullableOptional

Optional database integration id. When omitted, the project's default database integration is used.

Header parameters

norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses

200

OK

application/json

get/{version}/database/taxonomies/tree

GET /{version}/database/taxonomies/tree HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "tree": [
    {}
  ]
}

In the dashboard

Manage this visually in Norbix Cloud — see Database.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Get Database Taxonomy Tree in the SDK reference, with examples in every language.