Get descendants of a term
GET https://{{base_url}}/v3/taxonomies/{{taxonomy_uid}}/terms/{{term_uid}}/descendants
The Get descendants of a term request returns all the child terms of a specific term available in a particular taxonomy.
To use the API Request, you will need to authenticate yourself either with a Management Token (highly recommended) or an Authtoken.Â
Read more about it in Authentication.
For more information, refer to the Get descendants of a term API Reference document
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
depth | number | The response includes terms beginning at the root level and continuing to the specified depth. | |
include_children_count | boolean | Set this parameter to 'true' to include in response the total count of child terms available in the parent term. | |
include_referenced_entries_count | boolean | Set this parameter to 'true' to include in response the total count of entries in which the term is added. | |
include_count | boolean | Set this parameter to 'true' to include in response the total count of terms available in the specified taxonomy. | |
include_order | boolean | Set this parameter to 'true' to include in response the order of the terms available in a taxonomy. | |
limit | number | Enter the maximum number of terms to be returned. | |
skip | number | Enter the number of terms to be skipped from the response body. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
api_key | string | Enter the API key of the stack. | |
authtoken | string | Enter your authtoken. | |
authorization | string | For this call we recommend you to use management token. | |
Content-Type | string |