Marubox

Business Box API

Bookings, event types, availability and webhooks for a Business Box account. Authenticate with a personal API key as a bearer token. All times are ISO 8601…

Data & analytics#calendar

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Bookings, event types, availability and webhooks for a Business Box account. Authenticate with a personal API key as a bearer token. All times are ISO 8601 UTC; money is an integer in the currency’s minor units, and JPY is zero-decimal, so 5000 is ¥5,000.

Endpoints 13

Account

  • GETGet the authenticated account/meReturns the account the token belongs to, and the scopes the token carries. Integration platforms call this to test a connection and to label it.

Event types

  • GETList event types/event-typesThe things people can book. Use this to populate an event type dropdown. Ordered as they appear in the app.
  • GETList available start times/event-types/:id/slots?from=string&to=stringAvailable start times for an event type, as UTC instants, after availability, calendar conflicts, buffers, notice and daily limits have been applied. The…

Bookings

  • GETList bookings/bookingsBookings, newest first by default. Held and awaiting-payment bookings are excluded unless asked for by status: they are in-flight states, not bookings anyone…
  • POSTCreate a booking/bookingsBooks 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…
  • GETGet a booking/bookings/:id
  • POSTCancel a booking/bookings/:id/cancelCancels a booking exactly as the app does: the customer is emailed, and a paid booking is refunded in full. Idempotent — cancelling an already-cancelled…

Invites

  • POSTCreate a single-use booking link/invitesMints 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…

Webhooks

  • GETList webhook subscriptions/webhooksSecrets are never returned here.
  • POSTSubscribe to events/webhooksRegisters 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…
  • GETGet a webhook subscription/webhooks/:idUsed by trigger nodes to check that a subscription still exists.
  • DELETEDelete a webhook subscription/webhooks/:idIdempotent: an unknown id also returns 204, so an unsubscribe never fails on a retry.
  • POSTRe-enable a disabled webhook subscription/webhooks/:id/enableStarts delivering again to a subscription that was switched off after a long run of failures, keeping its id and its signing secret. Without this an…

API details

Base URL
https://api.marubox.jp/v1
Authentication
A bearer token in the Authorization header
Operations
13 operations on 10 pathsGET 7POST 5DELETE 1
Main resources
Webhooks 5Bookings 4Event types 2Account 1Invites 1
Response formats
application/json
Webhooks
5 described
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the Business Box API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Business Box API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get the authenticated account” (GET /me), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Business Box API?

Bookings, event types, availability and webhooks for a Business Box account. Authenticate with a personal API key as a bearer token. All times are ISO 8601… It is listed under Data & analytics and has 13 endpoints.

Who publishes the Business Box API?

It is listed from Marubox's public API description (an OpenAPI document), not published by Marubox on Swastik Codes. Anyone who controls marubox.jp can claim the profile by adding a DNS TXT record.

What is the base URL of the Business Box API?

Requests go to https://api.marubox.jp/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Business Box API?

With A bearer token in the Authorization header.

How many endpoints does the Business Box API have?

13 operations on 10 paths (7 GET, 5 POST, 1 DELETE). The largest groups are Webhooks, Bookings, Event types, Account.

Is forking the Business Box API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.