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 region
api.whautomate.comList locations
GET
/v1/locationsLists the active locations of the account.
Headers
x-api-keystringrequiredYour Whautomate API key.
Query parameters
limitintegerResults per page (default 10, max 100).
pageintegerPage number, from 1 (default 1).
searchTextstringText to search for.
Response 200
idstringtitlestringaddressLine1stringaddressLine2stringcitystringdistrictstringpostalCodestringphonestringRequest
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-keystringrequiredYour Whautomate API key.
Path parameters
locationIdstringrequiredLocation (workspace) id. Get ids from GET /v1/locations.
Response 200
idstringtitlestringaddressLine1stringaddressLine2stringcitystringdistrictstringpostalCodestringphonestringRequest
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-infoReturns the account the API key belongs to. Useful to check that a key works.
Headers
x-api-keystringrequiredYour Whautomate API key.
Response 200
namestringrequiredownerEmailstringenabledModulesstring[]planEditionstringRequest
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"
}