Full API documentation is available at the link that matches your server:
US server: https://apidoc.waitwell.us/
Canadian server: https://apidoc.waitwell.ca/
Before you can call any WaitWell API endpoint, you will need two things: your Site ID and an API Key. This article walks you through generating both.
Getting Started
API keys inherit the permissions of the staff account they are attached to. For the majority of integrations, an example being Power BI, we recommend one of the following:
A staff record with Organization Admin or Admin level permissions, or
A dedicated "dummy" staff account (with fake credentials and Admin access) created solely for API access. This keeps the integration isolated from individual staff members who may change roles or leave the organization.
Step 1: Locate Your Site ID
Every API request must include a siteid that identifies your WaitWell account and location.
Navigate to Settings > Customer Site/App > Customer Site Settings.
Find your main client website URL. It will contain a 3–6 digit number (for example,
226.waitwell.ca).For most integrations, the Site ID must be formatted as a 6-digit number with leading zeros:
URL | Site ID |
226.waitwell.ca | 000226 |
5190.waitwell.ca | 005190 |
61279.waitwell.ca | 061279 |
401921.waitwell.ca | 401921 |
If you manage multiple locations and need Site IDs for each, contact WaitWell support for a complete list.
Step 2: Generate Your API Key
Log in to your WaitWell staff account.
Open the Staff module and select the staff account you want to attach the key to.
Click Generate Key. A new API key will be populated on the record.
Copy the key and store it somewhere secure, as you would with a password.
📌 Important: The API key inherits the access permissions of the staff account it is attached to. If that account is deactivated, its permissions change or has a throttled level of access (like an Agent role), the key's behavior will change accordingly.
Step 3: Use Your API Key
Every API request must include your key in an HTTP header named x-apikey. You can test your key directly from the API docs site using the Authorize button at https://apidoc.waitwell.us/ or https://apidoc.waitwell.ca/
To retrieve a list of all Site IDs associated with your account, use the /mysites endpoint documented on that page.
API Limits
API calls are limited to 100 requests per minute. Exceeding this limit will return a 429 Too Many Requests response. Should this limit need to be increased, please contact your WaitWell Account Manager for next steps.