> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.markup.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.markup.ai/_mcp/server. # List Term Sets GET https://api.markup.ai/brand-terms/term-sets 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. Reference: https://docs.markup.ai/developer-reference/api-reference/brand-terms/list-term-sets ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Query parameters - `page` (integer, optional, default: 1) — Page number (1-based) - `page_size` (integer, optional, default: 20) — Number of items per page - `search_term` (string, optional, nullable) — Optional search term to filter term sets - `domain_ids` (list of string, optional, nullable) — Optional domain filter (any of these domains) - `has_context` (boolean, optional, nullable) — 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 ### 200 Successful Response - `term_sets` (list of TermSetWithTerms, required) - `total_count` (integer, required) - `total_unfiltered_term_sets` (integer, required) - `page` (integer, required) - `page_size` (integer, required) - `total_pages` (integer, required) ## Errors ### 401 Unauthorized Error Authentication failed or no valid API key provided. - `detail` (string, required) — A description of the error that occurred. - `status` (integer, required) — The HTTP status code generated by the server for this issue - `request_id` (string, required) — A unique ID associated with the HTTP request. ### 403 Forbidden Error Forbidden - `detail` (string, required) — A description of the error that occurred. - `status` (integer, required) — The HTTP status code generated by the server for this issue - `request_id` (string, required) — A unique ID associated with the HTTP request. ### 422 Unprocessable Entity Error Validation Error - `detail` (list of ValidationError, optional) ### 500 Internal Server Error Internal Server Error - `detail` (string, required) — A description of the error that occurred. - `status` (integer, required) — The HTTP status code generated by the server for this issue - `request_id` (string, required) — A unique ID associated with the HTTP request. ## Types ### TermSetWithTerms Term set with all associated terms for term management UI - `id` (string, required) - `context` (string, required) - `created_at` (datetime, required) - `updated_at` (datetime, required) - `terms` (list of TermDetail, required) - `term_type` (enum, optional, nullable) - Allowed values: `preferred`, `prohibited` - `context_polarity` (enum, optional, nullable) - Allowed values: `include`, `exclude` - `created_by` (string, optional, nullable) - `updated_by` (string, optional, nullable) - `domains` (list of DomainSummary, optional, default: []) ### ValidationError - `loc` (list of ValidationErrorLocItems, required) - `msg` (string, required) - `type` (string, required) ### TermDetail Detailed term information for term management UI - `id` (string, required) - `term` (string, required) - `type` (enum, required) - Allowed values: `preferred`, `prohibited` - `created_at` (datetime, required) - `updated_at` (datetime, required) - `case_sensitive` (boolean, optional, default: false) - `created_by` (string, optional, nullable) - `updated_by` (string, optional, nullable) ### DomainSummary - `id` (string, required) - `name` (string, required) ### ValidationErrorLocItems - string - integer ## Examples **Request** ```json {} ``` **Response** ```json { "term_sets": [ { "id": "a3f1c2d4-5e6b-7890-abcd-ef1234567890", "context": "When writing about product pricing or subscription plans", "created_at": "2024-03-10T08:15:00Z", "updated_at": "2024-04-22T14:45:00Z", "terms": [ { "id": "b7e2d3f5-6a7c-8901-bcde-f23456789012", "term": "subscription plan", "type": "preferred", "created_at": "2024-03-10T08:15:00Z", "updated_at": "2024-03-10T08:15:00Z", "case_sensitive": false, "created_by": "jane.smith@acmecorp.com", "updated_by": "jane.smith@acmecorp.com" } ], "term_type": "preferred", "context_polarity": "include", "created_by": "jane.smith@acmecorp.com", "updated_by": "john.doe@acmecorp.com", "domains": [ { "id": "c9d4e5f6-7b8a-9012-cdef-345678901234", "name": "Marketing" } ] } ], "total_count": 42, "total_unfiltered_term_sets": 58, "page": 1, "page_size": 20, "total_pages": 3 } ``` **SDK Code** ```python import requests url = "https://api.markup.ai/brand-terms/term-sets" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.markup.ai/brand-terms/term-sets'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.markup.ai/brand-terms/term-sets" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.markup.ai/brand-terms/term-sets") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.markup.ai/brand-terms/term-sets") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api.markup.ai/brand-terms/term-sets', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.markup.ai/brand-terms/term-sets"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.markup.ai/brand-terms/term-sets")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```