Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to SuperSaaS

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  3. Create the SuperSaaS connection

    In AgentKit > Connections, create a SuperSaaS connection. The name you give it is the connection_name your code passes. See Configure connections.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • supersaas_agenda_listList one user's appointments in a schedule.Read-only

    List 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-only

    List 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-only

    Get 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-only

    List 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-only

    List 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-only

    List 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-only

    List 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-only

    Get 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.