optional

Paginated listing of taxonomy terms

Full information on a taxonomy term

get/taxonomy_terms

Query parameters

searchstring

Full text search.

pageinteger

Page number of paginated result.

per_pageinteger

Number of results requested in a single page.

formatstring

Return results in the specified format. Default is json. Could be ndjson which should stream all the results without pagination.

taxonomy_idstring

Search for records which contain any term with this taxonomy.

top_onlyboolean

Only retrieve taxonomy terms that have not child terms.

parent_idstring

Recieve taxonomy terms that have a parent with this id.

Response

Paginated listing of taxonomy terms

total_itemsinteger

The total number of entities (e.g. services, organizations) returned

total_pagesinteger

Count of total pages.

page_numberinteger

The number of the current page

sizeinteger

The number of entities in the current page.

first_pageboolean

A Boolean value indicating if this is the first page

last_pageboolean

A Boolean value indicating if this is the last page

emptyboolean required

A Boolean value indicating if there is an empty result set

contentsTaxonomyTermJson[] required— unresolved $ref