Get Term Set

GET

https://api.markup.ai/brand-terms/term-sets/:term_set_id

GET

/brand-terms/term-sets/:term_set_id

curl https://api.markup.ai/brand-terms/term-sets/term_set_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "context": "Marketing Campaign Q2 2024",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "terms": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "term": "EcoFriendly",
      "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": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "name": "example.com"
    }
  ]
}

Authentication

AuthorizationBearer

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

Path parameters

term_set_idstringRequiredformat: "uuid"

UUID of the term set

Response

Successful Response

idstringformat: "uuid"

contextstring

created_atdatetime

updated_atdatetime

termslist of objects

term_typeenum or nullOptional

context_polarityenum or nullOptional

created_bystring or nullOptional

updated_bystring or nullOptional

domainslist of objectsOptionalDefaults to []

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error