Locations

List all Locations currently accessible to the requester. (Possibly paginated.)

get/locations

Request

Query parameters

allowedstring

If set to true, the items in the response may contain the allowed list property

limitinteger

Maximum number of Locations returned in a paged result set.

pagestring

Next page result set key.

Response

An array of Locations

Example response

{
  "items": [
    {
      "locationId": "6b3d1909-1e1c-43ec-adc2-5f941de4fbf9",
      "name": "Home",
      "parent": {
        "type": "LOCATIONGROUP",
        "id": "6ecb6c06-7319-49b1-8ebd-f97660efdd06"
      }
    }
  ],
  "_links": {
    "next": {
      "href": "https://..."
    },
    "previous": {
      "href": "https://..."
    }
  }
}

Changes