The WaitQ API lets your website, your own software or a developer you work with connect directly to your WaitQ account. With an API key, they can read your locations and lists, add guests to a waitlist or guest list, create bookings and orders, look up customers, and receive webhooks when something happens.
If you want to connect WaitQ to apps like Google Sheets, Slack or HubSpot without writing code, use Zapier instead.
The API is available on the Business plan and with an Access Pass. You need to be a business admin to create API keys.
1. Create an API key
Go to Integrations and click Configure on the API and Webhooks card. Enter a name that says where the key is used, for example "Website" or "Booking kiosk", and click Create API key.
Copy the key straight away. For your security, WaitQ shows it only once. If you lose it, revoke it and create a new one.
Create a separate key for each tool or developer. That way you can see when each one was last used, and stop one without affecting the others.
2. Share the key and the documentation
Give the key to the person building the integration, together with the API documentation. It covers every endpoint, the webhook events and code examples.
Keep the key on a server. Anyone with it can read customer details and create records in your business, so don't put it in your website's public code or share it in an email thread.
What the API can do
- Read your setup: locations, waitlists, booking lists, guest lists and order lists, and the fields each form asks for.
- Check availability: the open booking times of a booking list.
- Create records: add a guest to a waitlist or guest list, create a booking or a pick-up order.
- Look things up: find a customer by phone or email, or a guest on a guest list.
- Get webhooks: WaitQ calls your URL when a guest joins a waitlist or changes status, a booking is created or confirmed, a guest is added to a guest list or checks in, or a new customer is added.
Guests, bookings and orders created through the API don't receive automatic join or confirmation messages from WaitQ.
Manage or revoke a key
Your active keys are listed in Integrations → API and Webhooks → Configure, with the date each was last used. Click Revoke to stop a key. Every request and webhook that uses it stops working straight away.
Keys you created for Zapier are listed separately, in the Zapier dialog.
If you move to a plan without integrations, the API stops answering for your business until you upgrade again.
Getting help
For questions about your WaitQ account, lists or API keys, contact WaitQ support. Developers can find request formats, error codes and limits in the API documentation.