Softr
App · 21 actions
Create and manage Softr databases, tables, fields and records, and search table data.
Actions
| Action | What it does |
|---|---|
| Create database | Create a new database in the specified workspace. |
| Create field | Add a new field to a table. |
| Create record | Create a new record in the specified table. |
| Create table | Create a new table in the specified database. |
| Delete database | Delete a specific database by its ID. |
| Delete field | Delete a specific field from a table. |
| Delete record | Delete a specific record by its ID. |
| Delete table | Delete a specific table by its ID. |
| Get database | Retrieve details of a specific database by its ID. |
| Get field | Retrieve details of a specific field. |
| Get record | Retrieve details of a specific record by its ID. |
| Get table | Retrieve details of a specific table by its ID. |
| List databases | Retrieve a list of all databases accessible to the authenticated user. |
| List records | Retrieve a list of all records in the specified table. |
| List tables | Retrieve a list of all tables in the specified database. |
| List views | Retrieve a list of views for a specific table. |
| Search records | Search for records in the specified table based on filter, sort, and pagination criteria. |
| Update database | Update the details of an existing database. |
| Update field | Update the properties of a specific field. |
| Update record | Partially update a specific record by its ID. |
| Update table | Update a table's name and/or description. |
Create database
Create a new database in the specified workspace.
Inputs
- Workspace id
workspace_idtextRequired - Workspace id.
- Name
nametextRequired - Name.
- Description
descriptiontext - Description.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"description": "example",
"id": "example",
"name": "example",
"tablesCount": 1,
"updatedAt": "example",
"workspaceId": "example"
}
}
}Create field
Add a new field to a table.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Name
nametextRequired - Name.
- Type
typetextRequired - Type.One of:
SINGLE_LINE_TEXT(Single line text),CHECKBOX,CURRENCY,DATE,DATETIME,DURATION,EMAIL,SELECT,NUMBER,ATTACHMENT, and 5 more. - Options
optionsobject - Options.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"aiOptions": {
"aiFillable": false,
"aiModel": "example",
"aiOnly": false,
"allowWebSearch": false,
"canBeTriggeredManually": false,
"prompt": "example",
"runWhenRecordIsCreated": false,
"runWhenRecordIsUpdated": false
},
"allowMultipleEntries": false,
"createdAt": "example",
"defaultValue": "example",
"description": "example",
"id": "example",
"locked": false,
"name": "example",
"options": {},
"readonly": false,
"required": false,
"type": "SINGLE_LINE_TEXT",
"updatedAt": "example"
}
}
}Create record
Create a new record in the specified table.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Field names
field_namestrue/false - If true, use field names as keys in the response fields object instead of field IDs.Default:
false. - Fields
fieldsobject - A map of Field IDs to their values.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"fields": {},
"id": "example",
"tableId": "example",
"updatedAt": "example"
}
}
}Create table
Create a new table in the specified database.
Inputs
- Database
database_idtextRequired - databaseId.
- Name
nametext - Name.
- Description
descriptiontext - Description.
- Primary field name
primary_field_nametext - Primary field name.
- Fields
fieldslist - Fields.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"defaultViewId": "example",
"description": "example",
"fields": [],
"id": "example",
"name": "example",
"primaryFieldId": "example",
"updatedAt": "example"
}
}
}Delete database
Delete a specific database by its ID. It can only be deleted if it is empty, unless the 'force' parameter is used.
Inputs
- Database
database_idtextRequired - databaseId.
- Force
forcetrue/false - force.Default:
false.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Delete field
Delete a specific field from a table.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Field
field_idtextRequired - fieldId.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Delete record
Delete a specific record by its ID.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Record
record_idtextRequired - recordId.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Delete table
Delete a specific table by its ID. It can only be deleted if it is empty, unless the 'force' parameter is used.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Force
forcetrue/false - force.Default:
false.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get database
Retrieve details of a specific database by its ID.
Inputs
- Database
database_idtextRequired - databaseId.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"description": "example",
"id": "example",
"name": "example",
"tablesCount": 1,
"updatedAt": "example",
"workspaceId": "example"
}
}
}Get field
Retrieve details of a specific field.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Field
field_idtextRequired - fieldId.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"aiOptions": {
"aiFillable": false,
"aiModel": "example",
"aiOnly": false,
"allowWebSearch": false,
"canBeTriggeredManually": false,
"prompt": "example",
"runWhenRecordIsCreated": false,
"runWhenRecordIsUpdated": false
},
"allowMultipleEntries": false,
"createdAt": "example",
"defaultValue": "example",
"description": "example",
"id": "example",
"locked": false,
"name": "example",
"options": {},
"readonly": false,
"required": false,
"type": "SINGLE_LINE_TEXT",
"updatedAt": "example"
}
}
}Get record
Retrieve details of a specific record by its ID.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Record
record_idtextRequired - recordId.
- Field names
field_namestrue/false - If true, use field names as keys in the fields object instead of field IDs.Default:
false.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"fields": {},
"id": "example",
"tableId": "example",
"updatedAt": "example"
}
}
}Get table
Retrieve details of a specific table by its ID.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"defaultViewId": "example",
"description": "example",
"fields": [],
"id": "example",
"name": "example",
"primaryFieldId": "example",
"updatedAt": "example"
}
}
}List databases
Retrieve a list of all databases accessible to the authenticated user.
Inputs
None.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": []
}
}List records
Retrieve a list of all records in the specified table.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Offset
offsetnumber - offset.Default:
0. - Limit
limitnumber - limit.Default:
10. - Field names
field_namestrue/false - If true, use field names as keys in the fields object instead of field IDs.Default:
false. - View id
view_idtext - Filter records by a specific view.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"metadata": {
"limit": 1,
"offset": 1,
"total": 1
}
}
}List tables
Retrieve a list of all tables in the specified database.
Inputs
- Database
database_idtextRequired - databaseId.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": []
}
}List views
Retrieve a list of views for a specific table.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": []
}
}Search records
Search for records in the specified table based on filter, sort, and pagination criteria.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Field names
field_namestrue/false - If true, use field names as keys in the fields object instead of field IDs.Default:
false. - Filter
filterobject - Filter.
- Sorting
sortinglist - Sorting.
- Paging
pagingobject - Paging.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"metadata": {
"limit": 1,
"offset": 1,
"total": 1
}
}
}Update database
Update the details of an existing database.
Inputs
- Database
database_idtextRequired - databaseId.
- Name
nametext - Name.
- Description
descriptiontext - Description.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"description": "example",
"id": "example",
"name": "example",
"tablesCount": 1,
"updatedAt": "example",
"workspaceId": "example"
}
}
}Update field
Update the properties of a specific field.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Field
field_idtextRequired - fieldId.
- Name
nametext - Name.
- Type
typetext - Type.One of:
SINGLE_LINE_TEXT(Single line text),CHECKBOX,CURRENCY,DATE,DATETIME,DURATION,EMAIL,SELECT,NUMBER,ATTACHMENT, and 5 more. - Options
optionsobject - Options.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"aiOptions": {
"aiFillable": false,
"aiModel": "example",
"aiOnly": false,
"allowWebSearch": false,
"canBeTriggeredManually": false,
"prompt": "example",
"runWhenRecordIsCreated": false,
"runWhenRecordIsUpdated": false
},
"allowMultipleEntries": false,
"createdAt": "example",
"defaultValue": "example",
"description": "example",
"id": "example",
"locked": false,
"name": "example",
"options": {},
"readonly": false,
"required": false,
"type": "SINGLE_LINE_TEXT",
"updatedAt": "example"
}
}
}Update record
Partially update a specific record by its ID. Only the fields provided in the request body will be changed.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Record
record_idtextRequired - recordId.
- Field names
field_namestrue/false - If true, use field names as keys in the response fields object instead of field IDs.Default:
false. - Fields
fieldsobject - A map of Field IDs to their new values.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"fields": {},
"id": "example",
"tableId": "example",
"updatedAt": "example"
}
}
}Update table
Update a table's name and/or description. To modify fields, use the field-specific endpoints.
Inputs
- Database
database_idtextRequired - databaseId.
- Table
table_idtextRequired - tableId.
- Name
nametext - Name.
- Description
descriptiontext - Description.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"defaultViewId": "example",
"description": "example",
"fields": [],
"id": "example",
"name": "example",
"primaryFieldId": "example",
"updatedAt": "example"
}
}
}