# Supersaas

Appointment Scheduling for Every Situation

- **Category:** scheduling & booking
- **Auth:** API_KEY, BASIC
- **Composio Managed App Available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `SUPERSAAS`
- **Version:** 00000000_00

## Tools

### Create User

**Slug:** `SUPERSAAS_CREATE_USER`

Tool to create a new user in SuperSaaS. Use when you need to add a user to the account. The username is required; all other fields are optional. If a foreign_key is provided, SuperSaaS will use it instead of generating its own ID. Set duplicate='raise' to prevent creating duplicate users with the same foreign key.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the user to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | User ID. Numeric IDs are SuperSaaS keys, alphanumeric are your foreign keys. |
| `form` | boolean | No | Include attached form data in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `schedule_id` | integer | No | The ID of the schedule. Omit this parameter to retrieve User object fields instead of Schedule fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account` | string | Yes | Account name for authentication |
| `api_key` | string | Yes | Administrator API key for authentication |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Promotion code to retrieve a single promotion. If provided, returns only the specified promotion. |
| `limit` | integer | No | Maximum number of promotions to return. Use for pagination. |
| `offset` | integer | No | Number of promotions to skip before returning results. Use for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `SUPERSAAS_LIST_USERS`

Tool to list all users in the SuperSaaS account. Use when you need to retrieve users with optional pagination using limit and offset parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form` | boolean | No | Include attached form data with each user. Set to true to retrieve additional form information. |
| `limit` | integer | No | Maximum number of users to return. Default is 100, maximum is 1000. |
| `offset` | integer | No | Offset for pagination. Use to skip a specified number of users before starting to return results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User

**Slug:** `SUPERSAAS_UPDATE_USER`

Tool to update an existing SuperSaaS user by ID. Use when you need to modify user details like name, email, phone, or role.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | User ID to update |
| `name` | string | No | Username (max 50 characters) |
| `role` | string ("regular" | "superuser" | "blocked") | No | Role levels for users in SuperSaaS |
| `email` | string | No | Email address |
| `phone` | string | No | Phone number |
| `credit` | integer | No | Credit level balance |
| `mobile` | string | No | Mobile phone number |
| `address` | string | No | Mailing address |
| `full_name` | string | No | Full name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |