Skip to main content
New to Corsair? See API access, authentication, and error handling.

Bookings

create

bookings.create Book an appointment; SuperSaaS may email the customer a confirmation, depending on the schedule settings. A resource schedule needs start and finish, a capacity schedule needs a slot id Risk: destructive
Input Output

delete

bookings.delete Delete a booking, which frees its time for someone else and cannot be undone Risk: destructive · Irreversible
Input Output

get

bookings.get Read a single booking by id Risk: read
Input Output

list

bookings.list List bookings for a schedule, optionally within a start and finish window (resource and service schedules) Risk: read
Input Output: object[]

update

bookings.update Change a booking’s time or details; SuperSaaS may email the customer about the change, depending on the schedule settings Risk: destructive
Input Output

Schedules

agenda

schedules.agenda Read one user’s appointments, either within a schedule or across the account Risk: read
Input Output

changes

schedules.changes Read the changes to a schedule since a time, which is how a sync catches up; omitting the time gives the ten most recent Risk: read
Input Output

free

schedules.free Read the free spaces in a schedule after a time, which is the availability check Risk: read
Input Output

range

schedules.range List the appointments in a schedule between two times Risk: read
Input Output

Slots

create

slots.create Create a slot on a capacity schedule, which appointments are then booked into Risk: write
Input Output

delete

slots.delete Delete a slot and the capacity it offered, and this cannot be undone Risk: destructive · Irreversible
Input Output

get

slots.get Read one slot with its capacity and how many places are taken Risk: read
Input Output

list

slots.list List the slots of a capacity schedule in a time window Risk: read
Input Output: object[]

update

slots.update Change a slot’s time or capacity Risk: write
Input Output

Users

create

users.create Create a user. The name is the login name and is the only required field; SuperSaaS assigns the id and returns it in a Location header Risk: write
Input Output

createWithKey

users.createWithKey Create a user under a key you choose. Reusing that key updates the existing record instead of creating another Risk: write
Input Output: object

delete

users.delete Delete a user. Their login stops working and their bookings lose the link, and this cannot be undone Risk: destructive · Irreversible
Input Output

get

users.get Read one user by SuperSaaS id or by your own key in the form 1234fk Risk: read
Input Output

list

users.list List the users on the account, paging with limit and offset; more than 1000 records needs offset Risk: read
Input Output: object[]

update

users.update Update a user. A PUT to an unknown id creates it unless notfound says otherwise, so an update can silently become a create Risk: write
Input Output