EP. Get List of Categories

Fetch list of metric categories configured for your company.

info

Categories are defined at company level, each metric at any location can be assigned none, one or more categories.

URI

/api/v1/companies/{COMPANY_ID}/categories

Request Query Parameters

Request Parameter	Description
COMPANY_ID	UUID assigned to your company

Response

The schema of the `data` section of JSON response

{
  "type": "array",
  "items": {
  "type": "object",
    "properties": {
      "category_id": {
        "type": "number"
      },
      "name": {
        "type": "string"
      }
    }
  }
}

Response Parameter	Description
category_id	A unique identifier of a category.
name	Category name.

Sample Response

{
 "data": [
  {
   "category_id": 109,
   "name": "Entries"
  },
  {
   "category_id": 110,
   "name": "Exits"
  },
  {
   "category_id": 111,
   "name": "Room Occupancy"
  },
  {
   "category_id": 112,
   "name": "Equipment Use"
  },
  {
   "category_id": 113,
   "name": "Exercise Length"
  }
 ],
 "success": true
}