Softr
Overview
Section titled “Overview”Softr is a no-code platform that lets you build client portals, internal tools, and web applications from Airtable in minutes. It provides user management and database APIs for quickly building applications without writing code. With the Softr integration in SquadOS, your agents can create and manage databases, tables, fields, and records directly in your organization’s Softr workspace.
- Official website: https://www.softr.io/
- Composio documentation: docs.composio.dev/toolkits/softr
Authentication
Section titled “Authentication”This tool uses an API key (API_KEY) to connect.
You will need the following fields:
| Field | Required | Description |
|---|---|---|
api_key | Yes | API key generated in the Softr dashboard, used to authenticate all database API requests. |
How to get credentials
Section titled “How to get credentials”- Go to softr.io and log in to your account.
- Inside your workspace, access settings by clicking your profile icon in the top-right corner.
- Navigate to Settings → API (or Workspace Settings → API Keys).
- Click Generate API Key (or Create new key) to create an API key.
- Copy the generated value — that is the value to use in the
api_keyfield when connecting in SquadOS.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
Softr. - Click the card to open the details modal and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above.
- Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)
Available actions
Section titled “Available actions”Create Database
Section titled “Create Database”SOFTR_CREATE_DATABASE
Tool to create a new database in a Softr workspace. Use when you need to set up a new database for storing data within a specific Softr workspace.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name of the new database. Choose a descriptive name that helps identify the database purpose. This will be displayed in the Softr interface. |
description | string | No | Optional description of the database. Provide additional context about the database purpose, data structure, or usage guidelines. |
workspaceId | string | Yes | The ID of the workspace where the database will be created. This is a required parameter that identifies which workspace will contain the new database. |
Output
Section titled “Output”| Name | 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. |
Create Record
Section titled “Create Record”SOFTR_CREATE_RECORD
Creates a new record in a Softr database table. Use when you need to add new data to a specific table in your Softr database.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
fields | object | Yes | Field values for the new record. This is a mapping of field IDs to their values. Field IDs are specific to your table schema in Softr. Example: {'c63tL': 'test@example.com', 'o0JWv': 'Test User'} |
table_id | string | Yes | The unique identifier of the table where the record will be created. |
database_id | string | Yes | The unique identifier of the database where the record will be created. |
Output
Section titled “Output”| Name | 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. |
Create Table
Section titled “Create Table”SOFTR_CREATE_TABLE
Tool to create a new table within a specified Softr database. Use when you need to add a new data structure with custom fields to organize information.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name of the new table. |
fields | array | Yes | Collection of field definitions for the table. At least one field is required. Each field must have a name and type. |
database_id | string | Yes | The unique identifier of the database where the table will be created. |
description | string | No | Optional description of the table to explain its purpose. |
primary_field_name | string | No | Designates which field serves as the primary identifier for records in this table. Must match the name of one of the fields in the fields array. |
Output
Section titled “Output”| Name | 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. |
Create Table Field
Section titled “Create Table Field”SOFTR_CREATE_TABLE_FIELD
Tool to add a new field to a Softr table. Use when you need to add a new column to an existing table, such as adding an email field, a text field, or any other field type to store additional data.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name of the new field. This will be the display name shown in the table and used to reference the field. Should be descriptive and unique within the table. |
type | string | Yes | The type of the field, which determines what kind of data can be stored. Common types include SINGLE_LINE_TEXT for short text, EMAIL for email addresses, NUMBER for numeric values, CHECKBOX for boolean values, and SELECT for dropdown choices. |
options | object | No | Configuration options specific to the field type. For SINGLE_LINE_TEXT, can include minLength and maxLength constraints. For SELECT, would include the list of choices. Can be an empty object {} if no specific options are needed. |
tableId | string | Yes | The unique identifier of the table where the field will be added. |
databaseId | string | Yes | The unique identifier of the database containing the table (UUID format). |
Output
Section titled “Output”| Name | 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. |
Delete database
Section titled “Delete database”SOFTR_DELETE_DATABASE
Tool to delete a specific database by its ID from Softr. Use when you need to remove a database. The database must be empty unless the force parameter is set to true. This operation is irreversible.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
force | boolean | No | If true, deletes the database even if it contains tables or records. If false (default), deletion will fail if the database is not empty. Use with caution as this operation is irreversible. |
database_id | string | Yes | The unique identifier of the database to delete. |
Output
Section titled “Output”| Name | 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. |
Delete Record
Section titled “Delete Record”SOFTR_DELETE_RECORD
Tool to delete a record from a Softr database table. Use when you need to permanently remove a specific record.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
table_id | string | Yes | The unique identifier of the table containing the record. |
record_id | string | Yes | The unique identifier of the record to delete. |
database_id | string | Yes | The unique identifier of the database containing the table. |
Output
Section titled “Output”| Name | 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. |
Delete Table
Section titled “Delete Table”SOFTR_DELETE_TABLE
Tool to delete a specific table by its ID from a database. Use when you need to remove a table. The table must be empty unless the force parameter is set to true.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
force | boolean | No | If true, deletes the table even if it contains records. If false (default), deletion fails if table is not empty. |
table_id | string | Yes | The unique identifier of the table to delete. |
database_id | string | Yes | The unique identifier of the database. |
Output
Section titled “Output”| Name | 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. |
Delete Table Field
Section titled “Delete Table Field”SOFTR_DELETE_TABLE_FIELD
Tool to delete a field from a Softr database table. Use when you need to remove a field from a table. Returns success confirmation upon completion.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
field_id | string | Yes | The unique identifier of the field to delete. |
table_id | string | Yes | The unique identifier of the table. |
database_id | string | Yes | The unique identifier of the database. |
Output
Section titled “Output”| Name | 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. |
Get Database
Section titled “Get Database”SOFTR_GET_DATABASE
Tool to retrieve details for a specific database by ID. Use when you need to fetch information about a particular database in Softr.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
database_id | string | Yes | The unique identifier of the database to retrieve. |
Output
Section titled “Output”| Name | 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. |
Get Databases
Section titled “Get Databases”SOFTR_GET_DATABASES
Tool to retrieve all databases available in the workspace. Use when you need to list or discover available databases for further operations.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of databases to return per request. Defaults to returning all if not specified. |
offset | integer | No | Number of databases to skip for pagination. Defaults to 0 if not specified. |
Output
Section titled “Output”| Name | 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. |
Get Record
Section titled “Get Record”SOFTR_GET_RECORD
Tool to retrieve a single record by its ID from a Softr database table. Use when you need to fetch detailed information about a specific record.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tableId | string | Yes | The unique identifier of the table. |
recordId | string | Yes | The unique identifier of the record to retrieve. |
databaseId | string | Yes | The unique identifier of the database. |
Output
Section titled “Output”| Name | 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. |
Get records from table
Section titled “Get records from table”SOFTR_GET_RECORDS
Tool to retrieve a paginated list of records from a Softr table. Use when you need to fetch records from a specific table with optional pagination parameters.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of records to return per request. Defaults to 10 if not specified. |
offset | integer | No | Number of records to skip for pagination. Defaults to 0 if not specified. |
tableId | string | Yes | The unique identifier of the table. |
databaseId | string | Yes | The unique identifier of the database. |
Output
Section titled “Output”| Name | 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. |
Get Table
Section titled “Get Table”SOFTR_GET_TABLE
Tool to retrieve details for a specific table by ID. Use when you need to inspect table structure, fields, or metadata.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
table_id | string | Yes | The unique identifier of the table to retrieve. |
database_id | string | Yes | The unique identifier of the database containing the table. |
Output
Section titled “Output”| Name | 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. |
Get Table Field
Section titled “Get Table Field”SOFTR_GET_TABLE_FIELD
Tool to retrieve a specific field from a Softr table by field ID. Use when you need detailed configuration information about a table field, including its type, options, and metadata.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
fieldId | string | Yes | The field identifier. |
tableId | string | Yes | The table identifier. |
databaseId | string | Yes | The database identifier (UUID format). |
Output
Section titled “Output”| Name | 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. |
Get Tables
Section titled “Get Tables”SOFTR_GET_TABLES
Retrieves all tables within a specified Softr database. Use when you need to list or explore the tables available in a database.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
databaseId | string | Yes | The unique identifier of the database to retrieve tables from. |
Output
Section titled “Output”| Name | 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. |
Get Table Views
Section titled “Get Table Views”SOFTR_GET_TABLE_VIEWS
Tool to retrieve all views for a specified table in a Softr database. Use when you need to list or inspect available views for a table.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
table_id | string | Yes | The unique identifier of the table whose views are to be retrieved. |
database_id | string | Yes | The unique identifier of the database containing the table. |
Output
Section titled “Output”| Name | 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. |
Search Records
Section titled “Search Records”SOFTR_SEARCH_RECORDS
Tool to search records in a Softr database table with filtering and pagination. Use when you need to retrieve records from a specific table, optionally filtered by field values and paginated for large result sets.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
filter | object | No | Filter conditions for searching records. Structure varies based on table schema and filter requirements. |
paging | object | No | Pagination options for record search. |
table_id | string | Yes | The unique identifier of the table to search records in. |
database_id | string | Yes | The unique identifier of the database containing the table. |
Output
Section titled “Output”| Name | 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. |
Update Database
Section titled “Update Database”SOFTR_UPDATE_DATABASE
Tool to update an existing database’s name and/or description. Use when you need to modify database metadata after creation.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | The new name for the database. |
database_id | string | Yes | The unique identifier of the database to update. |
description | string | No | The new description for the database. |
Output
Section titled “Output”| Name | 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. |
Update a record
Section titled “Update a record”SOFTR_UPDATE_RECORD
Tool to update an existing record’s field values in a Softr table. Use when you need to modify specific fields of a record by providing the database ID, table ID, record ID, and the new field values.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
fields | object | Yes | A map of field IDs to their new values. Field IDs are unique identifiers for each column in the table (e.g., 'o0JWv'). The values can be strings, numbers, booleans, or other types depending on the field type in your Softr table schema. |
table_id | string | Yes | The unique identifier of the table containing the record. |
record_id | string | Yes | The unique identifier of the record to update. |
database_id | string | Yes | The unique identifier of the database containing the table. |
Output
Section titled “Output”| Name | 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. |
Update Table
Section titled “Update Table”SOFTR_UPDATE_TABLE
Tool to update a table’s name and/or description in Softr Database. Use when you need to modify table metadata. To modify fields, use the field-specific endpoints instead.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name of the table (required by API). |
table_id | string | Yes | The unique identifier of the table. |
database_id | string | Yes | The unique identifier of the database. |
description | string | No | The new description of the table. |
Output
Section titled “Output”| Name | 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. |
Update table field
Section titled “Update table field”SOFTR_UPDATE_TABLE_FIELD
Updates an existing field in a Softr table. Use when you need to modify a field’s name, type, or configuration options. Note: The API requires both type and options fields even if only updating the name.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | The new name of the field. If not provided, the field name remains unchanged. |
type | string | Yes | The field type. Must be provided even if not changing the type. Common types: SINGLE_LINE_TEXT (text), EMAIL (email validation), NUMBER (numeric), CHECKBOX (boolean), SELECT (dropdown), LONG_TEXT (multi-line text). |
options | object | Yes | Configuration options specific to the field type. For SINGLE_LINE_TEXT: {minLength: 0, maxLength: 1024}. For NUMBER: {precision: 2}. For SELECT: {choices: ['Option1', 'Option2']}. Structure varies by field type. |
field_id | string | Yes | The unique identifier of the field to update. |
table_id | string | Yes | The unique identifier of the table. |
database_id | string | Yes | The unique identifier of the database. |
Output
Section titled “Output”| Name | 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. |