latestOpenAPI 3.0.0Apache 2.02026-08-06199181.1 MB

e0d144609998

Terms

List terms

List all terms

get/terms

Query parameters

namestring

Search terms by name

filtersobject

Filter terms by the above query parameters. <br /> <b>Example:</b> { "name[eq]" : "15 Days" } which will search for terms with name = "15 Days".

sort[asc]'name'

Sort terms in ascending order

sort[desc]'name'

Sort terms in descending order

pageinteger

The particular page to return

per_pageinteger

The number of items to return per page Default: 50 Limit: 200

Response

Successful operation

messagestring

Example response

{
  "message": "success.",
  "terms": [
    {
      "id": 1,
      "name": "15 Days",
      "number_of_days": 15,
      "label": "15 Days"
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 50,
    "total": 1,
    "count": 1
  }
}