Skip to main content
POST
/
api
/
location
/
getLocations
Get locations
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
}
'
{
  "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>",
      "qualifiedAddress": {
        "addressLine2": "<string>",
        "addressline1": "<string>",
        "administrativeArea": "<string>",
        "locality": "<string>",
        "postalCode": "<string>",
        "regionCode": "<string>"
      },
      "subLocations": "<array>",
      "tz": "<string>",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

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

warningMsg
string | null