Get locations

Get list of locations in organization

POST /api/location/getLocations

Get locations

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/location/getLocations \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "subLocationsIncluded": false
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "locations": [
    {
      "address1": "<string>",
      "address2": "<string>",
      "countryCode": "<string>",
      "floorPlans": [
        {
          "eastEdge": 123,
          "floorLabel": "<string>",
          "floorNumber": 123,
          "imageUrl": "<string>",
          "mediaUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "northEdge": 123,
          "rotation": 123,
          "southEdge": 123,
          "westEdge": 123
        }
      ],
      "labels": [
        "<string>"
      ],
      "latitude": 123,
      "longitude": 123,
      "name": "<string>",
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "postalCode": "<string>",
      "subLocations": "<array>",
      "tz": "<string>",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting list of locations in organization.

subLocationsIncluded · boolean | null

Whether to include sub-locations in the response

Example:

false

Response

200 - application/json

OK

Response object containing list of locations in organization.

error · boolean | null

errorMsg · string | null

locations · object[] | null

List of locations in the organization

Show child attributes

warningMsg · string | null