API reference

All 12 operations, generated from the OpenAPI document so it cannot fall behind the API.

Account#

Who the token belongs to

Get the authenticated account#

GEThttps://api.marubox.jp/v1/me

Returns the account the token belongs to, and the scopes the token carries. Integration platforms call this to test a connection and to label it.

Operation id getMe · Errors: 400, 401, 403, 404, 409, 429

Returns 200

Event types#

What people can book, and when

List event types#

GEThttps://api.marubox.jp/v1/event-types

The things people can book. Use this to populate an event type dropdown. Ordered as they appear in the app.

Operation id listEventTypes · Errors: 400, 401, 403, 404, 409, 429

Query parameters

Returns 200

List available start times#

GEThttps://api.marubox.jp/v1/event-types/{id}/slots

Available start times for an event type, as UTC instants, after availability, calendar conflicts, buffers, notice and daily limits have been applied. The range may span at most 31 days. Invite-only event types are included, because the caller owns them.

Operation id listAvailableSlots · Errors: 400, 401, 403, 404, 409, 429

Query parameters

Returns 200

Bookings#

Read, create and cancel bookings

List bookings#

GEThttps://api.marubox.jp/v1/bookings

Bookings, newest first by default. Held and awaiting-payment bookings are excluded unless asked for by status: they are in-flight states, not bookings anyone should act on. Items are full booking objects, so a polling trigger can emit them directly.

Operation id listBookings · Errors: 400, 401, 403, 404, 409, 429

Query parameters

Returns 200

Create a booking#

POSThttps://api.marubox.jp/v1/bookings

Books a time on behalf of a customer, exactly as adding one by hand in the app does. The customer is emailed a confirmation unless notify is false. No card payment is taken, even for a paid event type. A time that is no longer free returns 409 slot_unavailable: the API never double-books.

Operation id createBooking · Errors: 400, 401, 403, 404, 409, 429

Request body

Returns 201

Get a booking#

GEThttps://api.marubox.jp/v1/bookings/{id}

Operation id getBooking · Errors: 400, 401, 403, 404, 409, 429

Query parameters

Returns 200

Cancel a booking#

POSThttps://api.marubox.jp/v1/bookings/{id}/cancel

Cancels a booking exactly as the app does: the customer is emailed, and a paid booking is refunded in full. Idempotent — cancelling an already-cancelled booking returns it unchanged.

Operation id cancelBooking · Errors: 400, 401, 403, 404, 409, 429

Query parameters

Request body

Returns 200

Invites#

Single-use booking links

Create a single-use booking link#

POSThttps://api.marubox.jp/v1/invites

Mints a booking link that works once and then stops. Use it to reply to an enquiry. Works for public and invite-only event types, and the invitee skips the anti-spam checks because the link already proves you meant them. The url is returned only here.

Operation id createInviteLink · Errors: 400, 401, 403, 404, 409, 429

Request body

Returns 201

Webhooks#

Subscribe to events

List webhook subscriptions#

GEThttps://api.marubox.jp/v1/webhooks

Secrets are never returned here.

Operation id listWebhooks · Errors: 400, 401, 403, 404, 409, 429

Query parameters

Returns 200

Subscribe to events#

POSThttps://api.marubox.jp/v1/webhooks

Registers an endpoint to receive events. The secret is returned only here: store it, and verify the BB-Signature header on every delivery. Returns a Location header pointing at the subscription.

Operation id createWebhook · Errors: 400, 401, 403, 404, 409, 429

Request body

Returns 201

Get a webhook subscription#

GEThttps://api.marubox.jp/v1/webhooks/{id}

Used by trigger nodes to check that a subscription still exists.

Operation id getWebhook · Errors: 400, 401, 403, 404, 409, 429

Query parameters

Returns 200

Delete a webhook subscription#

DELETEhttps://api.marubox.jp/v1/webhooks/{id}

Idempotent: an unknown id also returns 204, so an unsubscribe never fails on a retry.

Operation id deleteWebhook · Errors: 400, 401, 403, 404, 409, 429

Query parameters

Webhook payloads#

These are requests we send to you. Each arrives as JSON with a BB-Signature header — see Webhooks for verification.

booking.created#

A booking became confirmed for the first time. Paid bookings fire only once payment succeeds.

booking.rescheduled#

A booking moved. Exactly one event: no cancelled/created pair.

booking.cancelled#

A booking was cancelled by the booker, the host or the system.

booking.no_show#

A booking was marked as a no-show.

Last reviewed 28 September 2026.