Locations

GET /reports/locations

Resource information

Response Format JSON
Requires Authentication? Yes
Rate Limited? Yes
Requests / 1 minute window 60

Parameters

Name Required Description Example
locationId optional Comma separated numerical IDs of the desired customer(s). 1,2,3
count optional Specifies the number of results to return per page (see page below). The default is 15, with a maximum of 5,000. 20
page optional Causes the collection of events to be broken into "pages" of consistent sizes (specified by the count parameter). If no page is provided, a value of 1 will be assumed, which is the first "page." 1

Response


{
  "currentPage": 1,
  "nextPage": null,
  "previousPage": null,
  "totalPages": 1,
  "itemCount": 15,
  "items": [
    {
      "locationId": 1,
      "name": "Section 114",
    },
    ...
  ]
}