Skip to main content

Locations

Locations are the workspaces (branches) of your account. Most endpoints take a locationId (or location) to say which one to work in, so start here to get the ids. Locations are read only through the API; deactivated locations are not listed and requests that name one return 404.

API regionapi.whautomate.com

List locations​

GET /v1/locations

Lists the active locations of the account.

Headers
x-api-keystringrequired
Your Whautomate API key.
Query parameters
limitinteger
Results per page (default 10, max 100).
pageinteger
Page number, from 1 (default 1).
searchTextstring
Text to search for.
Response 200
idstring
titlestring
addressLine1string
addressLine2string
citystring
districtstring
postalCodestring
phonestring
Request
curl -X GET "https://api.whautomate.com/v1/locations?limit=2" \
-H "x-api-key: YOUR_API_KEY"
Response 200
[
{
"id": "Le6dWjQF9K",
"title": "Serene Wellness Studio",
"addressLine1": "22 Duxton Road",
"addressLine2": null,
"city": "Singapore",
"district": null,
"postalCode": "089485",
"phone": "+6561234567"
},
{
"id": "xP9JwUC8Ss",
"title": "Serene Wellness Orchard",
"addressLine1": "391 Orchard Road",
"addressLine2": "",
"city": "",
"district": "",
"postalCode": "238872",
"phone": ""
}
]

Get a location​

GET /v1/locations/{locationId}

Gets one location by id.

Headers
x-api-keystringrequired
Your Whautomate API key.
Path parameters
locationIdstringrequired
Location (workspace) id. Get ids from GET /v1/locations.
Response 200
idstring
titlestring
addressLine1string
addressLine2string
citystring
districtstring
postalCodestring
phonestring
Request
curl -X GET "https://api.whautomate.com/v1/locations/Le6dWjQF9K" \
-H "x-api-key: YOUR_API_KEY"
Response 200
{
"id": "Le6dWjQF9K",
"title": "Serene Wellness Studio",
"addressLine1": "22 Duxton Road",
"addressLine2": null,
"city": "Singapore",
"district": null,
"postalCode": "089485",
"phone": "+6561234567"
}

Get account info​

GET /v1/account-info

Returns the account the API key belongs to. Useful to check that a key works.

Headers
x-api-keystringrequired
Your Whautomate API key.
Response 200
namestringrequired
ownerEmailstring
enabledModulesstring[]
planEditionstring
Request
curl -X GET "https://api.whautomate.com/v1/account-info" \
-H "x-api-key: YOUR_API_KEY"
Response 200
{
"name": "Serene Wellness Studio",
"ownerEmail": "maya@serenewellness.example",
"enabledModules": [
"crm",
"bookings"
],
"planEdition": "complete"
}