GuidesChangelogAPI Reference
API Reference

/api/v5/term/

get
https://percolate.com/api/v5/term/

Retrieve a list of terms. Required values: either of (ids | scope_ids | parent_ids). Optional values: depth & search.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

A CSV of unique term IDs to filter by.

string
enum

Includes related items in the response.

Allowed:
string

A CSV of scope IDs to filter by.

boolean
Defaults to false

Look inside any child scopes in addition to the supplied ones.

integer

Limit the number of paginated results.

integer

A 0-based offset to adjust the pagination window.

string

A CSV of parent term IDs to filter by.

string of strings

A CSV of modes to filter by: - regular: Filter "standalone" terms - taxonomy: Filter terms that are part of a taxonomy tree

integer
Defaults to 1

If the value of depth is 1, the direct child of the root would be returned. Otherwise, it has no expected behaviour and differs from term to another.

string

Search terms by name.

string

Term namespace.

Responses

Retry-After header

500

Internal server error

Updated over 2 years ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago