API reference

Businesses and users

Find or register a bookmi business, and look up, create or disable its users. We never handle passwords — bookmi sends the password-setup email.

• Find or register a business
• Look up, create and disable users
• Resend the setup email

Sign-in (SSO)

Customers sign in to your service with their bookmi account. Standard authorization-code flow returning a signed ID token.

• Authorization-code flow
• ID token (verified with public keys)
• Sessions revoked on disable or lock

Plans and purchases

Read the plans, add-ons and products a business has, and create purchase links for plans and point packs. The business pays on bookmi's confirmation page.

• Entitlements
• Plan and point-pack catalog
• Purchase links
• Orders

Points and metering

Settle what your service uses against the business's bookmi points. Includes a pre-use gate, balance and usage records for reconciliation.

• Admission gate
• Balance
• Usage metering
• Usage records

Knowledge search

Search a business's knowledge base with a question. Read-only; no bulk export.

• Search by question

Webhooks

Signed notifications to your https URL when something changes — no polling.

• Product enabled / disabled
• Plan purchased / expired
• Points purchased
• Business details updated
• User disabled / locked / re-enabled

Can I read or write reservation or customer data?

Not at the moment. The API covers businesses and users, sign-in (SSO), plans and purchases, points metering, knowledge search and event notifications. Tell us if you need other data.

Which services are connected?

Our group's AI Phone is the first integration. We're open to discussing external services once we understand the use case.

Are there rate limits?

Yes — limits apply per service and per business (figures are in the spec). When you hit one, wait as the Retry-After header says and try again.

Will the API change?

The API is versioned. Breaking changes ship as a new version in parallel, and old versions stay for at least six months. New fields are non-breaking, so please ignore fields you don't recognise.

How is the data kept safe?

Traffic is encrypted with HTTPS (TLS), keys can be revoked and reissued at any time, and webhooks are signed. Data is stored in data centers in Tokyo, and bookmi does not use it to train AI models. See our Security page for details.