Softr

App · 21 actions

Create and manage Softr databases, tables, fields and records, and search table data.

Actions

ActionWhat it does
Create databaseCreate a new database in the specified workspace.
Create fieldAdd a new field to a table.
Create recordCreate a new record in the specified table.
Create tableCreate a new table in the specified database.
Delete databaseDelete a specific database by its ID.
Delete fieldDelete a specific field from a table.
Delete recordDelete a specific record by its ID.
Delete tableDelete a specific table by its ID.
Get databaseRetrieve details of a specific database by its ID.
Get fieldRetrieve details of a specific field.
Get recordRetrieve details of a specific record by its ID.
Get tableRetrieve details of a specific table by its ID.
List databasesRetrieve a list of all databases accessible to the authenticated user.
List recordsRetrieve a list of all records in the specified table.
List tablesRetrieve a list of all tables in the specified database.
List viewsRetrieve a list of views for a specific table.
Search recordsSearch for records in the specified table based on filter, sort, and pagination criteria.
Update databaseUpdate the details of an existing database.
Update fieldUpdate the properties of a specific field.
Update recordPartially update a specific record by its ID.
Update tableUpdate a table's name and/or description.

Create database

Create a new database in the specified workspace.

Inputs

Workspace idworkspace_idtextRequired
Workspace id.
NamenametextRequired
Name.
Descriptiondescriptiontext
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

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
NamenametextRequired
Name.
TypetypetextRequired
Type.One of: SINGLE_LINE_TEXT (Single line text), CHECKBOX, CURRENCY, DATE, DATETIME, DURATION, EMAIL, SELECT, NUMBER, ATTACHMENT, and 5 more.
Optionsoptionsobject
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

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Field namesfield_namestrue/false
If true, use field names as keys in the response fields object instead of field IDs.Default: false.
Fieldsfieldsobject
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

Databasedatabase_idtextRequired
databaseId.
Namenametext
Name.
Descriptiondescriptiontext
Description.
Primary field nameprimary_field_nametext
Primary field name.
Fieldsfieldslist
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

Databasedatabase_idtextRequired
databaseId.
Forceforcetrue/false
force.Default: false.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Delete field

Delete a specific field from a table.

Inputs

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Fieldfield_idtextRequired
fieldId.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Delete record

Delete a specific record by its ID.

Inputs

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Recordrecord_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

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Forceforcetrue/false
force.Default: false.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get database

Retrieve details of a specific database by its ID.

Inputs

Databasedatabase_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

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Fieldfield_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

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Recordrecord_idtextRequired
recordId.
Field namesfield_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

Databasedatabase_idtextRequired
databaseId.
Tabletable_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

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Offsetoffsetnumber
offset.Default: 0.
Limitlimitnumber
limit.Default: 10.
Field namesfield_namestrue/false
If true, use field names as keys in the fields object instead of field IDs.Default: false.
View idview_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

Databasedatabase_idtextRequired
databaseId.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": []
  }
}

List views

Retrieve a list of views for a specific table.

Inputs

Databasedatabase_idtextRequired
databaseId.
Tabletable_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

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Field namesfield_namestrue/false
If true, use field names as keys in the fields object instead of field IDs.Default: false.
Filterfilterobject
Filter.
Sortingsortinglist
Sorting.
Pagingpagingobject
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

Databasedatabase_idtextRequired
databaseId.
Namenametext
Name.
Descriptiondescriptiontext
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

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Fieldfield_idtextRequired
fieldId.
Namenametext
Name.
Typetypetext
Type.One of: SINGLE_LINE_TEXT (Single line text), CHECKBOX, CURRENCY, DATE, DATETIME, DURATION, EMAIL, SELECT, NUMBER, ATTACHMENT, and 5 more.
Optionsoptionsobject
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

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Recordrecord_idtextRequired
recordId.
Field namesfield_namestrue/false
If true, use field names as keys in the response fields object instead of field IDs.Default: false.
Fieldsfieldsobject
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

Databasedatabase_idtextRequired
databaseId.
Tabletable_idtextRequired
tableId.
Namenametext
Name.
Descriptiondescriptiontext
Description.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": {
      "createdAt": "example",
      "defaultViewId": "example",
      "description": "example",
      "fields": [],
      "id": "example",
      "name": "example",
      "primaryFieldId": "example",
      "updatedAt": "example"
    }
  }
}

On this page