Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Search Terms

Search terms.

Every filter is optional and filters combine with AND; repeating a filter, or giving both a name and an ID for the same kind, matches any of the values. Results are ordered by surface, case-insensitively.

Categories can be given by name (language, status, domain) or by ID (*_ids); the *_ids_exclude variants drop terms carrying the category. Returns 400 naming every language, status or domain name that does not exist in this organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

querystring or nullOptional

Text to match against term surfaces; see match.

matchenumOptionalDefaults to contains

How query matches, case-insensitively: contains a substring, exact the whole surface, or wildcard the whole surface with % matching any run of characters and _ one character (escape either with \).

Allowed values:
languagelist of strings or nullOptional

Language name, such as en. Repeatable.

statuslist of strings or nullOptional

Status name, such as preferred. Repeatable.

domainlist of strings or nullOptional

Domain name. Repeatable. Also matches terms in the domain’s sub-domains.

entry_uuidlist of strings or nullOptional

Entry (concept) uuid. Repeatable.

term_uuidlist of strings or nullOptional
Term uuid. Repeatable.
language_idslist of strings or nullOptional
Language category ID.
language_ids_excludelist of strings or nullOptional
status_idslist of strings or nullOptional
Status category ID.
status_ids_excludelist of strings or nullOptional
domain_idslist of strings or nullOptional

Domain category ID; includes sub-domains.

domain_ids_excludelist of strings or nullOptional
msr_idslist of strings or nullOptional
Morphosyntactic restriction category ID.
msr_ids_excludelist of strings or nullOptional
creatorstring or nullOptional
Filter by creator username
created_afterstring or nullOptional

ISO datetime: terms created on or after

created_beforestring or nullOptional

ISO datetime: terms created on or before

modified_afterstring or nullOptional

ISO datetime: terms modified on or after

modified_beforestring or nullOptional

ISO datetime: terms modified on or before

custom_catlist of strings or nullOptional

Custom category-field filter token, repeatable: ‘<field_id>:<is|is_not>:<category_id>’

custom_textlist of strings or nullOptional

Custom text-field filter token, repeatable: ‘<field_id>:<text>’

include_custom_field_valuesbooleanOptionalDefaults to false
Include each term's custom field values.
head_terms_onlybooleanOptionalDefaults to false

Only return each entry’s head (primary) term.

group_by_conceptbooleanOptionalDefaults to false

Return whole entries: an entry matches when any of its terms does, every term of a matching entry is returned, and pagination counts entries instead of terms.

pageintegerOptional>=1Defaults to 1
page_sizeintegerOptional1-100Defaults to 20

Response

Successful Response
termslist of objects
total_countinteger
pageinteger
page_sizeinteger
total_pagesinteger

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error