Get a List of Categories

Gets a list of all categories defined on the HMP system.

Authorizations: Categories - VIEW

Requests

GET /apis/categories

Response

Success

{
  "data": [
    {
      "label": "Locations",
      "values": ["Montreal", "Chicago", "Austin"],
      "multipleValues": true,
      "allowCustomValues": true,
      "id": "5ee67847-d886-4fda-b755-ce4090fa8739",
      "customValues": [
        "Minneapolis"
      ]
      "index": 1,
      "group": "Teams"
    },
    {
      "label": "Sports",
      "values": ["Hockey", "Football", "Tennis"],
      "multipleValues": true,
      "allowCustomValues": true,
      "id": "102d21c2-3564-40cd-aed8-7e57ec6c9061",
      "customValues": []
      "index": 2,
      "group": "Teams"
    }
  ],
  "paging": {
    "results": 2,
    "pageSize": 15
  }
}

Error

Code	Payload	Description
404	{"code":"040012", "name":"NoResults", "message":"No results", "httpStatusCode":404}	No categories are defined.