List Term Sets | Markup AI

{

"term_sets": [

{

"id": "a3f1c2d4-5b6e-4f7a-9c8d-123456789abc",

"context": "Marketing campaign for Q2 product launch",

"created_at": "2024-01-15T09:30:00Z",

"updated_at": "2024-01-15T09:30:00Z",

"terms": [

{

"id": "b7e9f8a1-2c3d-4e5f-8a9b-9876543210fe",

"term": "EcoSmart",

"type": "preferred",

"created_at": "2024-01-15T09:30:00Z",

"updated_at": "2024-01-15T09:30:00Z",

"case_sensitive": false,

"created_by": "[email protected]",

"updated_by": "[email protected]"

}

"term_type": "preferred",

"context_polarity": "include",

"created_by": "[email protected]",

"updated_by": "[email protected]",

"domains": [

{

"id": "d4e5f6a7-b8c9-4d0e-9f1a-23456789abcd",

"name": "Consumer Electronics"

}

]

}

"total_count": 1,

"total_unfiltered_term_sets": 1,

"page": 1,

"page_size": 1,

"total_pages": 1

}

Get a pageable list of term sets with all their associated terms and domains. The search filter searches the term set context and term text fields.

Authentication

AuthorizationBearer

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

Query parameters

pageintegerOptional>=1Defaults to 1

Page number (1-based)

page_sizeintegerOptional1-100Defaults to 20

Number of items per page

search_termstring or nullOptional

Optional search term to filter term sets

domain_idslist of strings or nullOptional

Optional domain filter (any of these domains)

has_contextboolean or nullOptional

Filter by whether the term set has non-empty context. True returns only rules with conditional/contextual context; False returns only rules that apply universally.

Response

Successful Response

term_setslist of objects

total_countinteger

total_unfiltered_term_setsinteger

pageinteger

page_sizeinteger

total_pagesinteger

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error