Locations

In Whautomate, locations represent distinct branches or physical points of operation within your organization.

These locations serve as identifiable entities, allowing for organized management and segmentation of operations across various geographical or functional areas.

Retrieve Locations: Fetch a list of locations, enabling access to location-based information within the platform.

Get Location By Id: Retrieve detailed information about a specific location using its unique identifier (locationId), facilitating targeted access to location-specific data.

get

/v1/locations

Query parameters

limitstring

pagestring

searchTextstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/locations' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "title": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "city": "text",
    "district": "text",
    "postalCode": "text",
    "phone": "text"
  }
]

200 response

get

/v1/locations/{locationId}

Path parameters

locationIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/locations/{locationId}' \
  --header 'x-api-key: text'

200

200

{
  "id": "text",
  "title": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "city": "text",
  "district": "text",
  "postalCode": "text",
  "phone": "text"
}

200 response