The SuperSaaS connector lets your AI agent act in each user's SuperSaaS account. Each user connects their own SuperSaaS API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 30 tools.
- Tools
- 30
- What they doRead · write · destructive
- 19 · 7 · 419 read7 write4 destructive
- Users sign in with
- Username and password
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the SuperSaaS connection
In AgentKit > Connections, create a SuperSaaS connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolsupersaas_agenda_listList one user's appointments in a schedule.Read-onlyList User Agenda
List one user's appointments in a schedule. Returns bookings with id, start, finish, resource or service and form fields. Use this to show a customer their bookings. Use supersaas_range_list for all users.
Inputs
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
userstringrequired- The user's name or ID. Use 0 for the administrator. Example: jane@example.com.
fromstring- Only appointments after this local time, as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. Example: 2026-12-01.
slotboolean- Capacity schedules only: set true to group bookings under their slots, with slot details. Example: false.
supersaas_availability_listList the free spaces in a resource or capacity schedule after a given time.Read-onlyList Free Availability
List the free spaces in a resource or capacity schedule after a given time. Not available for service schedules. Returns slots with start, finish, title, description, location and free count. Use this to find bookable times before supersaas_booking_create.
Inputs
fromstringrequired- Only free spaces after this local time, as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. Example: 2026-12-01 09:00:00.
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
fullboolean- Capacity schedules: set true to include full slots. Example: false.
lengthinteger- Resource schedules: only free spaces of at least this many minutes. Example: 60.
maxresultsinteger- Maximum number of results. Defaults to 10. Example: 10.
resourcestring- Resource schedules: only free spaces of this resource name. Example: Room 1.
supersaas_booking_getGet one SuperSaaS appointment.Read-onlyGet Appointment
Get one SuperSaaS appointment. Returns the appointment's id, start, finish, resource, contact fields, status, price, created_by and timestamps. Use supersaas_bookings_list or supersaas_range_list to find IDs.
Inputs
idintegerrequired- Appointment (booking) ID. Example: 1234567.
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
formboolean- Set true to include the data of an attached custom form. Example: true.
supersaas_bookings_listList the appointments of a schedule, optionally within a time window.Read-onlyList Appointments
List the appointments of a schedule, optionally within a time window. Returns appointments with id, start, finish, resource, contact fields, status, price, created_on and updated_on. Use start and limit=1 to get the next appointment. Use supersaas_range_list for richer date filtering.
Inputs
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
finishstring- Resource and service schedules: only appointments until this time. Example: 2026-12-31.
formboolean- Set true to include the data of an attached custom form. Example: true.
limitinteger- Maximum number of results to return. Example: 100.
startstring- Resource and service schedules: only appointments from this time, as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. Example: 2026-12-01.
supersaas_changes_listList the appointments in a schedule that were created, changed or deleted since a given time.Read-onlyList Recent Changes
List the appointments in a schedule that were created, changed or deleted since a given time. Returns bookings (or slots with bookings) with id, start, finish, resource or service, deleted flag, created_on, updated_on and form fields. Use this to sync changes. Use supersaas_range_list for appointments in a date range.
Inputs
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
fromstring- Only changes after this UTC time, as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. The ten most recent changes are returned when empty. Example: 2026-11-01 00:00:00.
limitinteger- Maximum number of results to return. Example: 100.
offsetinteger- Number of results to skip, to page through large result sets. Example: 0.
slotboolean- Capacity schedules only: set true to group bookings under their slots, with slot details. Example: false.
tostring- Only changes before this UTC time, as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. Example: 2026-11-30 23:59:59.
userstring- Only bookings of this user (name, ID or foreign key). Use 0 for the administrator. Example: 1234fk.
supersaas_fields_listList the fields available on a schedule's appointments, or on the user object when schedule_id is empty.Read-onlyList Available Fields
List the fields available on a schedule's appointments, or on the user object when schedule_id is empty. Returns the field list with names and labels. Use this to see which fields a booking or user accepts.
Inputs
schedule_idinteger- Schedule ID. Leave empty to list the fields of the user object. Example: 524012.
supersaas_form_definitions_listList the custom form definitions in your SuperSaaS account.Read-onlyList Form Definitions
List the custom form definitions in your SuperSaaS account. Returns each form definition's ID and name. Use this to get a form_id for supersaas_forms_list.
Inputs
This tool takes no inputs.
supersaas_form_getGet one completed custom form by its ID.Read-onlyGet Completed Form
Get one completed custom form by its ID. Returns the form's id, reservation_process_id, content, created_on, updated_on, super_form_id, deleted and user_id. Use supersaas_forms_list to find form IDs.
Inputs
idintegerrequired- ID of the completed form. Example: 12345.
supersaas_forms_listList the completed custom forms of one form definition, optionally only those updated after a time or filled in by one user.Read-onlyList Completed Forms
List the completed custom forms of one form definition, optionally only those updated after a time or filled in by one user. Returns forms with id, reservation_process_id, content (answers by field number), created_on, updated_on and user_id. Use supersaas_form_definitions_list for form_id. Use supersaas_form_get for one form.
Inputs
form_idintegerrequired- ID of the form definition, from supersaas_form_definitions_list. Example: 34567.
fromstring- Only forms updated after this UTC time, as YYYY-MM-DD HH:MM:SS. Example: 2026-11-01 00:00:00.
limitinteger- Maximum number of forms. Defaults to 100. Example: 100.
offsetinteger- Number of results to skip, to page through large result sets. Example: 0.
userstring- Only forms of this user (name, ID or foreign key). Use 0 for the administrator. Example: 1234fk.
supersaas_groups_listList the user groups defined in your SuperSaaS account.Read-onlyList User Groups
List the user groups defined in your SuperSaaS account. Returns each group's ID and name. Use this for the group value when creating or updating users.
Inputs
This tool takes no inputs.
supersaas_promotion_getGet one SuperSaaS coupon code and how often it was used.Read-onlyGet Promotion Code
Get one SuperSaaS coupon code and how often it was used. Returns code, description and usage. Use supersaas_promotions_list to browse codes.
Inputs
idstringrequired- The coupon code. Example: SPRING25.
supersaas_promotions_listList the promotional coupon codes in your SuperSaaS account.Read-onlyList Promotion Codes
List the promotional coupon codes in your SuperSaaS account. Returns codes with code, description and usage count. Use supersaas_promotion_get for one code.
Inputs
limitinteger- Maximum number of results to return. Example: 100.
offsetinteger- Number of results to skip, to page through large result sets. Example: 0.
supersaas_range_listList the appointments (or, for capacity schedules, the slots) in a schedule within a time range.Read-onlyList Appointments in Range
List the appointments (or, for capacity schedules, the slots) in a schedule within a time range. Returns bookings or slots with id, start, finish, resource or service, created_on, updated_on and form fields. Use this for a calendar view. Use supersaas_agenda_list for one user's appointments.
Inputs
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
fromstring- Only appointments starting at or after this local time, as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. Defaults to now. Example: 2026-12-01.
limitinteger- Maximum number of results to return. Example: 100.
offsetinteger- Number of results to skip, to page through large result sets. Example: 0.
resource_idstring- Only appointments for this resource ID. Example: 31415.
service_idstring- Only appointments for this service ID. Example: 27182.
slotboolean- Capacity schedules only: set true to group bookings under their slots, with slot details. Example: false.
tostring- Only appointments starting before this local time, as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. Example: 2026-12-31.
todayboolean- Set true to return only today's appointments. Example: false.
userstring- Resource and service schedules: only bookings of this user (name, ID or foreign key). Use 0 for the administrator. Example: 1234fk.
supersaas_resources_listList the resources or services of a resource or service schedule.Read-onlyList Resources or Services
List the resources or services of a resource or service schedule. Not available for capacity schedules. Returns each resource's or service's ID and name. Use this for resource_id values when booking.
Inputs
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
supersaas_schedules_listList the schedules in your SuperSaaS account.Read-onlyList Schedules
List the schedules in your SuperSaaS account. Returns each schedule's ID and name. Use this first to get a schedule_id for the appointment and slot tools.
Inputs
This tool takes no inputs.
supersaas_slot_getGet one slot of a capacity schedule.Read-onlyGet Slot
Get one slot of a capacity schedule. Returns the slot's id, start, finish, title, description, location, capacity, level, waiting, color and price. Use supersaas_slots_list to find slot IDs.
Inputs
idintegerrequired- Slot ID. Example: 98765.
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
supersaas_slots_listList the slots of a capacity schedule in start-time order, optionally within a time window.Read-onlyList Slots
List the slots of a capacity schedule in start-time order, optionally within a time window. Returns slots with id, start, finish, title, description, location, capacity, level (places taken), waiting, color and price. Use this to find slot IDs. Use supersaas_range_list with slot=true to include each slot's bookings.
Inputs
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
finishstring- Only slots starting until this local time. Example: 2026-12-31.
limitinteger- Maximum number of slots, up to 2500. Defaults to 100. Example: 100.
offsetinteger- Number of results to skip, to page through large result sets. Example: 0.
startstring- Only slots starting from this local time, as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. Example: 2026-12-01.
supersaas_user_getGet one SuperSaaS user by SuperSaaS ID or by your own foreign key.Read-onlyGet User
Get one SuperSaaS user by SuperSaaS ID or by your own foreign key. Returns the user's id, fk, name, email, contact details, role, credit, custom fields, created_on and last_login. Use supersaas_users_list to find IDs.
Inputs
idstringrequired- User ID: the SuperSaaS numeric ID, or your own key followed by fk, such as 567fk. Example: 567fk.
formboolean- Set true to include the data of an attached custom form. Example: true.
supersaas_users_listList the users in your SuperSaaS account.Read-onlyList Users
List the users in your SuperSaaS account. Returns users with id, name, email, full_name, phone, role, credit, custom fields, created_on and last_login. Use this to browse users. Use supersaas_user_get for one user.
Inputs
formboolean- Set true to include the data of an attached custom form. Example: true.
limitinteger- Maximum number of users to return. Defaults to 100. Example: 100.
offsetinteger- Number of results to skip, to page through large result sets. Example: 0.
supersaas_booking_createCreate an appointment in a resource schedule (with start and finish) or a capacity schedule (with slot_id).WriteCreate Appointment
Create an appointment in a resource schedule (with start and finish) or a capacity schedule (with slot_id). Service schedules are not supported. Returns HTTP 201 with an empty body; the new ID is in the Location header, so use supersaas_range_list to find it afterwards. Use supersaas_availability_list first to find a free time or slot.
Inputs
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
addressstring- Postal address. Example: 1 Main Street, Springfield.
countrystring- Two-letter ISO 3166-1 country code. The account country is used when empty. Example: US.
emailstring- Email address of the person booking. Example: jane@example.com.
field_1_rstring- Value of the first custom appointment field. Example: First visit.
field_2_rstring- Value of the second custom appointment field. Example: Referral.
finishstring- Resource schedules: end time in local time, as YYYY-MM-DD HH:MM:SS. Example: 2026-12-01 11:00:00.
form_idinteger- ID of an existing custom form to attach to the appointment. Example: 12345.
full_namestring- Full name of the person booking. Example: Jane Doe.
mobilestring- Mobile number. Example: +1 555 0101.
phonestring- Phone number. Example: +1 555 0100.
resource_idstring- Resource schedules with several resources: the resource ID or name, from supersaas_resources_list. Example: Room 1.
slot_idinteger- Capacity schedules: ID of the slot to book into, from supersaas_slots_list or supersaas_availability_list. Example: 98765.
startstring- Resource schedules: start time in the schedule's local time, as YYYY-MM-DD HH:MM:SS. Example: 2026-12-01 10:00:00.
super_fieldstring- Value of the supervisor-only field. Example: Paid at desk.
user_idstring- Create the appointment on behalf of this user: SuperSaaS user ID, or your own key with fk such as 567fk. Example: 567fk.
webhookboolean- Set true to trigger the webhooks connected to the account or schedule. Example: false.
supersaas_booking_updateUpdate a SuperSaaS appointment.WriteUpdate Appointment
Update a SuperSaaS appointment. Only the fields you send change. Returns HTTP 200 with an empty body, 404 if it no longer exists, or 422 with errors. Use supersaas_booking_get first to see current values.
- Idempotent
Inputs
idintegerrequired- Appointment (booking) ID. Example: 1234567.
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
addressstring- Postal address. Example: 1 Main Street, Springfield.
countrystring- Two-letter ISO 3166-1 country code. The account country is used when empty. Example: US.
emailstring- Email address of the person booking. Example: jane@example.com.
field_1_rstring- Value of the first custom appointment field. Example: First visit.
field_2_rstring- Value of the second custom appointment field. Example: Referral.
finishstring- Resource schedules: end time in local time, as YYYY-MM-DD HH:MM:SS. Example: 2026-12-01 11:00:00.
form_idinteger- ID of an existing custom form to attach to the appointment. Example: 12345.
full_namestring- Full name of the person booking. Example: Jane Doe.
mobilestring- Mobile number. Example: +1 555 0101.
phonestring- Phone number. Example: +1 555 0100.
resource_idstring- Resource schedules with several resources: the resource ID or name, from supersaas_resources_list. Example: Room 1.
slot_idinteger- Capacity schedules: ID of the slot to book into, from supersaas_slots_list or supersaas_availability_list. Example: 98765.
startstring- Resource schedules: start time in the schedule's local time, as YYYY-MM-DD HH:MM:SS. Example: 2026-12-01 10:00:00.
super_fieldstring- Value of the supervisor-only field. Example: Paid at desk.
webhookboolean- Set true to trigger the webhooks connected to the account or schedule. Example: false.
supersaas_promotion_duplicateCreate a new coupon code by copying an existing code's settings.WriteDuplicate Promotion Code
Create a new coupon code by copying an existing code's settings. Returns the result of the copy. Create the template code on the Promotions screen first; this tool cannot set discount rules itself.
Inputs
idstringrequired- The new coupon code to create. Example: SPRING25-JANE.
template_codestringrequired- The existing coupon code to copy. Example: SPRING25.
supersaas_slot_createCreate a slot in a capacity schedule; other fields take the schedule's defaults.WriteCreate Slot
Create a slot in a capacity schedule; other fields take the schedule's defaults. Returns HTTP 201 with an empty body; the new slot ID is in the Location header, so use supersaas_slots_list to find it. Use the slot ID as slot_id in supersaas_booking_create.
Inputs
finishstringrequired- End time in local time, as YYYY-MM-DD HH:MM:SS. Must be after start. Example: 2026-12-01 19:00:00.
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
startstringrequired- Start time in the schedule's local time, as YYYY-MM-DD HH:MM:SS. Example: 2026-12-01 18:00:00.
capacitystring- Number of places. Send - for no limit, or 0 to accept no appointments. Example: 12.
colorstring- Color: a hex code such as #112233, or a number from 0 to 14 for a standard color. Example: #3366cc.
descriptionstring- Longer description, up to 2000 characters. Example: Beginner-friendly flow class.
locationstring- Location of the slot. Example: Studio A.
pricestring- Price of one appointment, when the schedule takes payment. Example: 15.00.
titlestring- Title shown on the slot. Example: Yoga class.
supersaas_slot_updateUpdate a slot in a capacity schedule.WriteUpdate Slot
Update a slot in a capacity schedule. Only the fields you send change; other occurrences of a repeating series are not changed. Returns HTTP 200 with an empty body, 404 if it no longer exists, or 422 with errors. Use supersaas_slot_get first to see current values.
- Idempotent
Inputs
idintegerrequired- Slot ID. Example: 98765.
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
capacitystring- Number of places. Send - for no limit, or 0 to accept no appointments. Example: 12.
colorstring- Color: a hex code such as #112233, or a number from 0 to 14 for a standard color. Example: #3366cc.
descriptionstring- Longer description, up to 2000 characters. Example: Beginner-friendly flow class.
finishstring- End time in local time, as YYYY-MM-DD HH:MM:SS. Must be after start. Example: 2026-12-01 19:00:00.
locationstring- Location of the slot. Example: Studio A.
pricestring- Price of one appointment, when the schedule takes payment. Example: 15.00.
startstring- Start time in the schedule's local time, as YYYY-MM-DD HH:MM:SS. Example: 2026-12-01 18:00:00.
titlestring- Title shown on the slot. Example: Yoga class.
supersaas_user_createCreate a user in your SuperSaaS account; SuperSaaS assigns the ID.WriteCreate User
Create a user in your SuperSaaS account; SuperSaaS assigns the ID. Returns HTTP 201 with an empty body; the new ID is in the response's Location header, so use supersaas_users_list to find the user afterwards. Use supersaas_user_update with your own key (such as 567fk) to create or update a user under your own ID.
Inputs
namestringrequired- Login name of the user, up to 50 characters. Must be an email address if the account uses email addresses as login names. Example: jane@example.com.
addressstring- Postal address. Example: 1 Main Street, Springfield.
countrystring- Two-letter ISO 3166-1 country code. Example: US.
creditstring- Credit balance, in the format chosen on the Payment Setup screen. Example: 10.
duplicatestring- Set raise to fail with an error instead of updating when the user already exists. Example: raise.one of
raise emailstring- Email address. Ignored when the login name is the email address. Example: jane@example.com.
field_1string- Value of the first custom user field. Example: Member.
field_2string- Value of the second custom user field. Example: Gold.
full_namestring- Full name. Example: Jane Doe.
groupinteger- ID of the group to put the user in, from supersaas_groups_list. Example: 1201.
mobilestring- Mobile number. Example: +1 555 0101.
phonestring- Phone number. Example: +1 555 0100.
roleinteger- User role: 3 regular user (default), 4 superuser, -1 blocked. Example: 3.one of
34-1 super_fieldstring- Value of the supervisor-only field. Example: VIP.
timezonestring- IANA time zone. Example: America/New_York.
webhookboolean- Set true to trigger the webhooks connected to the account or schedule. Example: false.
supersaas_user_updateUpdate a SuperSaaS user by ID.WriteUpdate or Create User
Update a SuperSaaS user by ID. If the user does not exist it is created, unless notfound is set. Returns HTTP 200 on success, or 422 with errors. Use your own key with an fk suffix (such as 567fk) to keep SuperSaaS in sync with your user database.
- Idempotent
Inputs
idstringrequired- User ID: the SuperSaaS numeric ID, or your own key followed by fk, such as 567fk. Example: 567fk.
addressstring- Postal address. Example: 1 Main Street, Springfield.
countrystring- Two-letter ISO 3166-1 country code. Example: US.
creditstring- Credit balance, in the format chosen on the Payment Setup screen. Example: 10.
emailstring- Email address. Ignored when the login name is the email address. Example: jane@example.com.
field_1string- Value of the first custom user field. Example: Member.
field_2string- Value of the second custom user field. Example: Gold.
full_namestring- Full name. Example: Jane Doe.
groupinteger- ID of the group to put the user in, from supersaas_groups_list. Example: 1201.
mobilestring- Mobile number. Example: +1 555 0101.
namestring- Login name of the user, up to 50 characters. Must be an email address if the account uses email addresses as login names. Example: jane@example.com.
notfoundstring- What to do when the user does not exist: error returns 404, ignore returns 200 without creating. Leave empty to create the user. Example: error.one of
errorignore phonestring- Phone number. Example: +1 555 0100.
roleinteger- User role: 3 regular user (default), 4 superuser, -1 blocked. Example: 3.one of
34-1 super_fieldstring- Value of the supervisor-only field. Example: VIP.
timezonestring- IANA time zone. Example: America/New_York.
webhookboolean- Set true to trigger the webhooks connected to the account or schedule. Example: false.
supersaas_booking_deleteDelete (cancel) a SuperSaaS appointment.DestructiveDelete Appointment
Delete (cancel) a SuperSaaS appointment. Returns HTTP 200 when deleted, or 404 when it no longer exists. Use this to cancel a booking.
- Idempotent
Inputs
idintegerrequired- Appointment (booking) ID. Example: 1234567.
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
webhookboolean- Set true to trigger the webhooks connected to the account or schedule. Example: false.
supersaas_promotion_deleteDelete a coupon code.DestructiveDelete Promotion Code
Delete a coupon code. Bookings that used it keep their discount. Returns HTTP 200 when deleted, or 404 when the code does not exist. Use this to retire a code.
- Idempotent
Inputs
idstringrequired- The coupon code to delete. Example: SPRING25-JANE.
supersaas_slot_deleteDelete a slot from a capacity schedule, together with every appointment booked into it, without notifying those people.DestructiveDelete Slot
Delete a slot from a capacity schedule, together with every appointment booked into it, without notifying those people. This cannot be undone. Returns HTTP 200 when deleted, or 404 when it no longer exists. Use supersaas_slot_get first if you need a record of its bookings.
- Idempotent
Inputs
idintegerrequired- Slot ID. Example: 98765.
schedule_idintegerrequired- Schedule ID. Get it from supersaas_schedules_list (it is also the number at the end of the schedule's Configure Overview URL). Example: 524012.
supersaas_user_deleteDelete a SuperSaaS user.DestructiveDelete User
Delete a SuperSaaS user. Returns HTTP 200 when deleted, or 404 when the user does not exist. Use this to remove users that left your system.
- Idempotent
Inputs
idstringrequired- User ID: the SuperSaaS numeric ID, or your own key followed by fk, such as 567fk. Example: 567fk.
webhookboolean- Set true to trigger the webhooks connected to the account or schedule. Example: false.
No tools match.