Skip to content

Meeting WhatsDo at the California Restaurant Show?

Check if your restaurant is AI-ready
WhatsDo

Developer docs

API access and documentation

Access is granted per developer during the closed beta. This page describes what you get, what the contract guarantees and what is not available yet.

There is no public API reference on this page. Endpoints, schemas, authentication and the supported action list are issued with credentials during the closed beta. What is published here is the contract those endpoints hold to.

01

How access works

Tell us what your agent does and which markets it serves. We review each request with the product team, then share the endpoint contract and the supported action list. Testing runs against a merchant we control.

  • 01Request access with your use case, expected volume and target vertical.
  • 02Receive credentials, base URL, auth scheme and the supported action list.
  • 03Run a first availability call against a connected merchant.
  • 04Run a booking against a controlled test merchant while the write path is in closed beta.

Email template

Access is granted per developer while the beta is closed. Send the four lines below and we reply with the endpoint, authentication and the merchant you can test against.

Subject: API access request

Agent or product:
What you want to book (service type and market):
Expected volume in the first month:
Test merchant: WhatsDo-controlled or your own Square account

The address for access requests appears here once the beta intake is open, so that a request has somewhere to land and someone to answer it. Nothing else about the template changes when it does.

02

Your first successful call

The first milestone is a live availability read against a supported backend. It returns the merchant, the service with its duration and price, and open slots in an explicit timezone.

  • 01Merchant identifier and the backend that answered.
  • 02Service name, duration, price and currency.
  • 03Open slots with an explicit timezone.
  • 04A request identifier you can quote in support.
One booking, end to end
  1. 01The agent asks what is freeOpen slots on the provider's own calendar, with the services, prices and currency the business actually publishes.
  2. 02The agent places the bookingThe exact service, time and price are restated to the customer, who confirms once.
  3. 03The booking landsA normal appointment appears in the calendar the staff already use. Nothing new to learn, nothing to migrate.
  4. 04The agent asks again laterThe same booking identifier maps to the same record, so repeating a request never creates a duplicate.

Availability read: live. Booking write: closed beta against a controlled merchant. Cancellation and reschedule: not available yet

Booking, retries and errors

These rules hold for every supported backend. They are what makes an agent booking safe to automate. The write itself is on the closed-beta path.

  • 01A write requires one explicit confirmation of an immutable summary: service, time, timezone, price and currency.
  • 02A confirmed booking returns a stable booking ID intended to match the provider record.
  • 03Repeating the same request returns the existing booking and creates no duplicate.
  • 04Errors carry a stable machine-readable code plus a recovery path.
  • 05Any human-completed step is flagged as manual fallback and excluded from automated success.

Not available yet

Listed here so you do not design around something that does not exist.

  • 01A booking write outside the closed beta. Writes run against a controlled merchant until the controlled run is published.
  • 02Cancellation and reschedule through the agent path.
  • 03Agent-initiated payment.
  • 04A public MCP install link for ChatGPT or Claude.
  • 05Self-serve signup. Credentials are issued by request during the closed beta.
  • 06Published rate limits and uptime commitments. These are agreed per integration.

Support

Every integration has a named contact on both sides during the beta. Quote the request identifier and the booking ID and we can trace the call end to end.

  • 01Technical questions and incident reports: support@whatsdo.com.
  • 02Include the request ID, booking ID, backend and timestamp.

Questions we get

Can I read the full API reference before requesting access?+

The complete contract, including endpoints and schemas, is issued with credentials during the closed beta. This page describes the guarantees so you can evaluate fit first.

Is there a sandbox?+

Testing is arranged against a WhatsDo-controlled merchant so bookings can be verified without touching a real business.

How long does access approval take?+

We reply to every request. Timing depends on the fit review and on whether you need a controlled merchant for testing.

Which backends can I book against?+

Square Appointments, with availability live and the booking write on the closed-beta write. Every response names the backend that answered, so your agent always knows which system fulfilled the request.

Get the endpoint, the auth and a merchant to test against.

Request API access

Your first calls run against a controlled merchant, never a live business.

Run a business? Start here