Skip to content
Mr Charles Mr Charles Developers

OpenAPI spec

The public endpoints are described in OpenAPI 3.1:

/openapi/mrcharles-public-v1.yaml

Terminal window
curl -O https://developers.mrcharles.app/openapi/mrcharles-public-v1.yaml

Generate a client

Section titled “Generate a client”
Terminal window
# TypeScript types
npx openapi-typescript https://developers.mrcharles.app/openapi/mrcharles-public-v1.yaml -o src/mrcharles.d.ts


# A full client, any language
npx @openapitools/openapi-generator-cli generate \
  -i https://developers.mrcharles.app/openapi/mrcharles-public-v1.yaml \
  -g typescript-fetch -o ./src/mrcharles

Postman and Insomnia both import the URL directly (Import → Link).

What is in it

Section titled “What is in it”

The eight public endpoints — site payload, resolve by host, availability, create hold, verify, resend, confirm, read and cancel a booking — with request bodies, response schemas and the error codes each one can return.

What is not

Section titled “What is not”
  • Studio endpoints. They need a signed-in member and are documented here; they are not part of the public spec.
  • Rate limits and captcha rules, which are operational rather than structural — see Errors & rate limits and Bot protection.
  • Webhooks. There are none for third parties yet. If you need booking events pushed to your system, tell us.