account_name on the account. The key is under Account Info, API Key.
- Every booking and slot call names its schedule.
schedule_idis sent as a query parameter; without it SuperSaaS answers 404. - Creates return the new id. SuperSaaS answers 201 with an empty body and the new record’s URL in
Location; the plugin returns{ created, id, location }. Updates and deletes answer an empty 200 and return{ id, updated }or{ id, deleted }. - Bookings can email the customer. A schedule set to send confirmations emails the customer on a booking create or change, so both are marked destructive. Turn confirmations off on the schedule’s Process tab for test runs.
- Schedule reads answer an envelope.
schedules.changes,range,agendaandfreereturn{ bookings }or, on a capacity schedule,{ slots }.
- 20 typed API operations
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the SuperSaaS API key before the first call: More: API Key
pnpm corsair setup --plugin=supersaas --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.4
Connect a tenant
Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.
Example API calls
List recent schedule changesWhat’s next
API reference
Every
supersaas.api.* operation with input and output types.Connect / OAuth
createLink, Hub delivery, and tenant connect flows.
Use with agents
Expose this plugin’s operations as MCP tools.