The platform · book.castomapi.com
Book
Bookings and availability: resources, slots, reservations, reminders and refunds by policy.
A resource has a calendar; a customer picks a slot; castomapi-book holds it, takes the payment through Pay if the seller wants one, and sends the reminder. Cancellation and refund policies are data the seller sets, not code.
Every product that needs "pick a time" — a clinic, a studio, a consultant, a rental — uses this instead of building it.
Operations
| Method | Path | Description |
|---|---|---|
| GET | /b/{id} | |
| POST | /b/{id}/cancel | |
| GET | /public/v1/bookings/{id} | The booking this link is for |
| POST | /public/v1/bookings/{id}/cancel | Give the time back |
| GET | /public/v1/calendars/{key} | What a practice offers, and how to reach it |
| GET | /public/v1/calendars/{key}/availability | Free times, computed from the practice's hours |
| POST | /public/v1/calendars/{key}/bookings | Ask for a time |
| GET | /v1/calendars | Every diary this account owns |
| POST | /v1/calendars | Open a diary |
| DELETE | /v1/calendars/{id} | Delete a diary and everything in it |
| GET | /v1/calendars/{id} | One diary, with its hours and visit types |
| PATCH | /v1/calendars/{id} | Change how the diary works |
| PUT | /v1/calendars/{id}/availability | Set the weekly opening hours |
| GET | /v1/calendars/{id}/bookings | The diary itself |
| POST | /v1/calendars/{id}/bookings/{bookingId}/cancel | Cancel somebody's appointment, and refund it |
| POST | /v1/calendars/{id}/exceptions | Close a day, or open an extra one |
| DELETE | /v1/calendars/{id}/exceptions/{exceptionId} | Undo a closed or extra day |
| DELETE | /v1/calendars/{id}/feed | Switch the calendar-app link off |
| POST | /v1/calendars/{id}/feed | Issue the calendar-app link for this diary (replaces the previous one) |
| POST | /v1/calendars/{id}/visit-types | Add something that can be booked |
| DELETE | /v1/calendars/{id}/visit-types/{typeId} | Remove a visit type |
| PATCH | /v1/calendars/{id}/visit-types/{typeId} | Change a visit type |
Base URL: https://book.castomapi.com · Open the live docs
The platform
Auth
One identity for every product: sign-in, sessions, OAuth clients, projects and the revocation keys every service checks.
Billing & plans
Plan entitlements for every castomo product: Stripe subscriptions in, effective quotas out, pushed to the product that enforces them.
Pay
Payments between people and businesses on the platform, with Stripe underneath.
Events
A free global events API: what is happening where, for dashboards and sites that need a calendar they did not write.
Data
Free global reference data: countries, languages, currencies, logistics, standards — tens of millions of records, no key.
Query
Read-only SQL and document queries against the customer's own MySQL, PostgreSQL or MongoDB, from a browser, safely.