Skip to main content
Softr logo
  • Category: app builder
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 21
  • Triggers: 0
  • Slug: SOFTR
  • Version: 20261101_00

Tools

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

string
required
The name of the new database. Choose a descriptive name that helps identify the database purpose. This will be displayed in the Softr interface.
string
Optional description of the database. Provide additional context about the database purpose, data structure, or usage guidelines.
string
required
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

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: SOFTR_CREATE_RECORDCreates 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

object
required
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’}
string
required
The unique identifier of the table where the record will be created
string
required
The unique identifier of the database where the record will be created

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: SOFTR_CREATE_TABLETool 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

string
required
The name of the new table.
array
required
Collection of field definitions for the table. At least one field is required. Each field must have a name and type.
string
required
The unique identifier of the database where the table will be created.
string
Optional description of the table to explain its purpose.
string
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

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: SOFTR_CREATE_TABLE_FIELDAdd a new field to an existing Softr table, choosing from the supported field types and supplying type-specific options.

Input Parameters

string
required
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.
string ("SINGLE_LINE_TEXT" | "CHECKBOX" | "CURRENCY" | "DATETIME" | "DURATION" | "EMAIL" | "SELECT" | "NUMBER" | "ATTACHMENT" | "RATING" | "LINKED_RECORD" | "LONG_TEXT" | "URL" | "PERCENT" | "BUTTON" | "PROGRESS" | "PHONE" | "DATE_RANGE" | "ADDRESS" | "TIME" | "LOOKUP" | "ROLLUP" | "FORMULA" | "COUNT" | "CREATED_AT" | "UPDATED_AT" | "CREATED_BY" | "UPDATED_BY" | "AUTONUMBER" | "RECORD_ID" | "USER")
required
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.
object
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.
string
required
The unique identifier of the table where the field will be added. This specifies which table within the database should receive the new field.
string
required
The unique identifier of the database containing the table. This is a UUID format identifier that specifies which database to use.

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: SOFTR_DELETE_DATABASETool 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

boolean
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.
string
required
The unique identifier of the database to delete. This is the database ID from Softr.

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: SOFTR_DELETE_RECORDTool to delete a record from a Softr database table. Use when you need to permanently remove a specific record.

Input Parameters

string
required
The unique identifier of the table containing the record
string
required
The unique identifier of the record to delete
string
required
The unique identifier of the database containing the table

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: SOFTR_DELETE_TABLETool 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

boolean
If true, deletes the table even if it contains records. If false (default), deletion fails if table is not empty.
string
required
The unique identifier of the table to delete
string
required
The unique identifier of the database

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: SOFTR_DELETE_TABLE_FIELDTool 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

string
required
The unique identifier of the field to delete
string
required
The unique identifier of the table
string
required
The unique identifier of the database

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: SOFTR_GET_DATABASETool to retrieve details for a specific database by ID. Use when you need to fetch information about a particular database in Softr.

Input Parameters

string
required
The unique identifier of the database to retrieve.

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: SOFTR_GET_DATABASESList Softr databases accessible to the authenticated user, with optional offset and limit parameters.

Input Parameters

integer
Maximum number of databases to return per request. Defaults to returning all if not specified.
integer
Number of databases to skip for pagination. Defaults to 0 if not specified.

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: SOFTR_GET_RECORDTool 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

string
required
The unique identifier of the table
string
required
The unique identifier of the record to retrieve
string
required
The unique identifier of the database

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: SOFTR_GET_RECORDSTool 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

integer
Maximum number of records to return per request. Defaults to 10 if not specified.
integer
Number of records to skip for pagination. Defaults to 0 if not specified.
string
required
The unique identifier of the table
string
required
The unique identifier of the database

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: SOFTR_GET_TABLETool to retrieve details for a specific table by ID. Use when you need to inspect table structure, fields, or metadata.

Input Parameters

string
required
The unique identifier of the table to retrieve
string
required
The unique identifier of the database containing the table

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: SOFTR_GET_TABLE_FIELDTool 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

string
required
The field identifier.
string
required
The table identifier.
string
required
The database identifier (UUID format).

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: SOFTR_GET_TABLESRetrieves tables within a specified Softr database for listing or exploration. The returned table objects omit their fields arrays.

Input Parameters

string
required
The unique identifier of the database to retrieve tables from.

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: SOFTR_GET_TABLE_VIEWSTool 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

string
required
The unique identifier of the table whose views are to be retrieved.
string
required
The unique identifier of the database containing the table.

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: SOFTR_SEARCH_RECORDSTool 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

object
Filter conditions for searching records. Structure varies based on table schema and filter requirements.
object
Pagination options for record search.
string
required
The unique identifier of the table to search records in.
string
required
The unique identifier of the database containing the table.

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: SOFTR_UPDATE_DATABASETool to update an existing database’s name and/or description. Use when you need to modify database metadata after creation.

Input Parameters

string
The new name for the database
string
required
The unique identifier of the database to update
string
The new description for the database

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: SOFTR_UPDATE_RECORDTool 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

object
required
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.
string
required
The unique identifier of the table containing the record.
string
required
The unique identifier of the record to update.
string
required
The unique identifier of the database containing the table.

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: SOFTR_UPDATE_TABLEUpdate a Softr database table’s name and optionally its description. A name is required even when changing the description.

Input Parameters

string
required
The name of the table (required by API)
string
required
The unique identifier of the table
string
required
The unique identifier of the database
string
The new description of the table

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: SOFTR_UPDATE_TABLE_FIELDUpdates 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

string
The new name of the field. If not provided, the field name remains unchanged.
string ("SINGLE_LINE_TEXT" | "CHECKBOX" | "CURRENCY" | "DATETIME" | "DURATION" | "EMAIL" | "SELECT" | "NUMBER" | "ATTACHMENT" | "RATING" | "LINKED_RECORD" | "LONG_TEXT" | "URL" | "PERCENT" | "BUTTON" | "PROGRESS" | "PHONE" | "DATE_RANGE" | "ADDRESS" | "TIME" | "LOOKUP" | "ROLLUP" | "FORMULA" | "COUNT" | "CREATED_AT" | "UPDATED_AT" | "CREATED_BY" | "UPDATED_BY" | "AUTONUMBER" | "RECORD_ID" | "USER")
required
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).
object
required
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.
string
required
The unique identifier of the field to update.
string
required
The unique identifier of the table.
string
required
The unique identifier of the database.

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