Get a list of taxonomies.

get

https://cti.example.com/api/v2/taxonomies

Required permissions

read taxonomies

Query Params

limit

int32

≥ 1

Maximum number of items to be returned

offset

int32

≥ 0

Return results starting from the specified (zero-based) index

sort

string

Comma-separated list of fields to sort on. Prefix a field with the minus "-" sign if you intend to apply descending sorting to it

data

boolean

Set this parameter to false if you want to only retrieve the number of objects matching the query

attributes

string

Comma-separated list of attributes to be returned. Nested attributes are separated by dots - e.g. data.title

filter[name]

string

Filter taxonomies by name.

filter[description]

string

Filter taxonomies by description.

filter[code]

string

Filter taxonomies by code. Only for retrieving Admiralty Code taxonomy nodes.

For example: filter[code]='A' retrieves the 'Admiralty Code - Completely reliable' taxonomy node. code is case- sensitive.

filter[is_system_defined]

boolean

Filter system-defined taxonomies

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The requested object(s)

401Unauthorized request

403Missing permissions