> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Supersaas

> Appointment Scheduling for Every Situation

![Supersaas logo](https://mintcdn.com/composio-preview/IA0_SoMcsWt17HEC/images/toolkits/supersaas.svg?fit=max\&auto=format\&n=IA0_SoMcsWt17HEC\&q=85\&s=67a02552c052bb7d78a729dbf4c25562)

* **Category:** scheduling & booking
* **Auth:** API\_KEY, BASIC
* **Composio-managed OAuth available?** N/A
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `SUPERSAAS`
* **Version:** 20261101\_00

## Tools

> [accordion] Create User
>
> **Slug:** `SUPERSAAS_CREATE_USER`
>
> Create a SuperSaaS user with a required username and optional user details and foreign key. If the foreign key already exists, the request updates that user unless duplicate handling is set to raise an error.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Username (max 50 chars). If account is configured for email-only login, this should be the email address.
>
> **role** `string ("regular" | "superuser" | "blocked")`
>
> Role levels for users in SuperSaaS
>
> **email** `string`
>
> Email address for the user
>
> **group** `integer`
>
> Group ID to assign the user to
>
> **phone** `string`
>
> Phone number
>
> **credit** `integer`
>
> Credit level for the user (default: 0)
>
> **mobile** `string`
>
> Mobile phone number
>
> **address** `string`
>
> Physical address of the user
>
> **country** `string`
>
> Two character ISO 3166-1 country code (e.g., US, GB, CA)
>
> **webhook** `boolean`
>
> Set to true to trigger webhooks connected to the account
>
> **password** `string`
>
> Password for the user account
>
> **timezone** `string`
>
> IANA timezone identifier (e.g., America/New\_York, Europe/London)
>
> **duplicate** `string`
>
> Set to 'raise' to return 422 error if a user with the same foreign key already exists. Only applicable when foreign\_key is provided.
>
> **full\_name** `string`
>
> Full name of the user
>
> **foreign\_key** `string`
>
> Your own foreign key in format '9999fk' (e.g., '12345fk'). If provided, SuperSaaS will use this instead of generating its own ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete User
>
> **Slug:** `SUPERSAAS_DELETE_USER`
>
> Tool to delete a SuperSaaS user by their ID. Use when you need to permanently remove a user from the system.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the user to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User
>
> **Slug:** `SUPERSAAS_GET_USER`
>
> Tool to read a single user by ID from SuperSaaS. Use when you need to retrieve detailed information about a specific user.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> User ID. Numeric IDs are SuperSaaS keys, alphanumeric are your foreign keys.
>
> **form** `boolean`
>
> Include attached form data in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Field List
>
> **Slug:** `SUPERSAAS_LIST_FIELD_LIST`
>
> Tool to retrieve available fields on Schedule or User objects. Use when you need to discover what custom fields are configured for a schedule or user profile.
>
> #### Input Parameters
>
> **schedule\_id** `integer`
>
> The ID of the schedule. Omit this parameter to retrieve User object fields instead of Schedule fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List User Groups
>
> **Slug:** `SUPERSAAS_LIST_GROUPS`
>
> Tool to retrieve all user groups defined in a SuperSaaS account. Use when you need to list groups for managing user access or organizing users.
>
> #### Input Parameters
>
> **account** `string` *required*
>
> Account name for authentication
>
> **api\_key** `string` *required*
>
> Administrator API key for authentication
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Promotions
>
> **Slug:** `SUPERSAAS_LIST_PROMOTIONS`
>
> Tool to list all promotional coupon codes in the account or retrieve a single promotion by code. Use when you need to view available promotions or check details of a specific promotion code.
>
> #### Input Parameters
>
> **id** `string`
>
> Promotion code to retrieve a single promotion. If provided, returns only the specified promotion.
>
> **limit** `integer`
>
> Maximum number of promotions to return. Use for pagination.
>
> **offset** `integer`
>
> Number of promotions to skip before returning results. Use for pagination.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Schedules
>
> **Slug:** `SUPERSAAS_LIST_SCHEDULES`
>
> Tool to retrieve all schedules in a SuperSaaS account with their IDs and names. Use when you need to list available schedules or get schedule IDs for other operations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Form Definitions
>
> **Slug:** `SUPERSAAS_LIST_SUPER_FORMS`
>
> Tool to retrieve all form definitions in a SuperSaaS account with their IDs and names. Use when you need to list available forms or get form IDs for other operations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Users
>
> **Slug:** `SUPERSAAS_LIST_USERS`
>
> List users in the SuperSaaS account using optional limit and offset pagination. Each call retrieves one page; the provider defaults to 100 records when no limit is supplied.
>
> #### Input Parameters
>
> **form** `boolean`
>
> Include attached form data with each user. Set to true to retrieve additional form information.
>
> **limit** `integer`
>
> Maximum number of users to return. Default is 100, maximum is 1000.
>
> **offset** `integer`
>
> Offset for pagination. Use to skip a specified number of users before starting to return results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update User
>
> **Slug:** `SUPERSAAS_UPDATE_USER`
>
> Update a SuperSaaS user by ID, including details such as name, email, phone, or role. If a non-internal key does not match an existing user, SuperSaaS may create a user instead.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> User ID to update
>
> **name** `string`
>
> Username (max 50 characters)
>
> **role** `string ("regular" | "superuser" | "blocked")`
>
> Role levels for users in SuperSaaS
>
> **email** `string`
>
> Email address
>
> **phone** `string`
>
> Phone number
>
> **credit** `integer`
>
> Credit level balance
>
> **mobile** `string`
>
> Mobile phone number
>
> **address** `string`
>
> Mailing address
>
> **full\_name** `string`
>
> Full name
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
