Skip to main content
Supersaas logo
  • Category: scheduling & booking
  • Auth: API_KEY, BASIC
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: SUPERSAAS
  • Version: 20261101_00

Tools

Slug: SUPERSAAS_CREATE_USERCreate 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

string
required
Username (max 50 chars). If account is configured for email-only login, this should be the email address.
string ("regular" | "superuser" | "blocked")
Role levels for users in SuperSaaS
string
Email address for the user
integer
Group ID to assign the user to
string
Phone number
integer
Credit level for the user (default: 0)
string
Mobile phone number
string
Physical address of the user
string
Two character ISO 3166-1 country code (e.g., US, GB, CA)
boolean
Set to true to trigger webhooks connected to the account
string
Password for the user account
string
IANA timezone identifier (e.g., America/New_York, Europe/London)
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.
string
Full name of the user
string
Your own foreign key in format ‘9999fk’ (e.g., ‘12345fk’). If provided, SuperSaaS will use this instead of generating its own ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERSAAS_DELETE_USERTool to delete a SuperSaaS user by their ID. Use when you need to permanently remove a user from the system.

Input Parameters

string
required
The unique identifier of the user to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERSAAS_GET_USERTool to read a single user by ID from SuperSaaS. Use when you need to retrieve detailed information about a specific user.

Input Parameters

string
required
User ID. Numeric IDs are SuperSaaS keys, alphanumeric are your foreign keys.
boolean
Include attached form data in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERSAAS_LIST_FIELD_LISTTool 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

integer
The ID of the schedule. Omit this parameter to retrieve User object fields instead of Schedule fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERSAAS_LIST_GROUPSTool 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

string
required
Account name for authentication
string
required
Administrator API key for authentication

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERSAAS_LIST_PROMOTIONSTool 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

string
Promotion code to retrieve a single promotion. If provided, returns only the specified promotion.
integer
Maximum number of promotions to return. Use for pagination.
integer
Number of promotions to skip before returning results. Use for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERSAAS_LIST_SCHEDULESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERSAAS_LIST_SUPER_FORMSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERSAAS_LIST_USERSList 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

boolean
Include attached form data with each user. Set to true to retrieve additional form information.
integer
Maximum number of users to return. Default is 100, maximum is 1000.
integer
Offset for pagination. Use to skip a specified number of users before starting to return results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SUPERSAAS_UPDATE_USERUpdate 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

string
required
User ID to update
string
Username (max 50 characters)
string ("regular" | "superuser" | "blocked")
Role levels for users in SuperSaaS
string
Email address
string
Phone number
integer
Credit level balance
string
Mobile phone number
string
Mailing address
string
Full name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not