Skip to main content

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.


API regionapi.whautomate.com

GET /v1/locations​

GET /v1/locations
Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
limitstring
pagestring
searchTextstring
Response 200
idstring
titlestring
addressLine1string
addressLine2string
citystring
districtstring
postalCodestring
phonestring
Request
curl -X GET "https://api.whautomate.com/v1/locations" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
[
  {
    "id": "string",
    "title": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "district": "string",
    "postalCode": "string",
    "phone": "string"
  }
]

GET /v1/locations/{locationId}​

GET /v1/locations/{locationId}
Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
locationIdstringrequired
Response 200
idstring
titlestring
addressLine1string
addressLine2string
citystring
districtstring
postalCodestring
phonestring
Request
curl -X GET "https://api.whautomate.com/v1/locations/{locationId}" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "id": "string",
  "title": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "district": "string",
  "postalCode": "string",
  "phone": "string"
}

Account info​

Returns the name and owner email of the account the API key belongs to. Useful to check that a key works.

GET /v1/account-info
Headers
x-api-keystringrequired
Your Whautomate API key.
Response 200
namestringrequired
ownerEmailstring
Request
curl -X GET "https://api.whautomate.com/v1/account-info" \
  -H "x-api-key: YOUR_API_KEY"
Response 200
{
  "name": "string",
  "ownerEmail": "string"
}
Last updated on