Teable

App · 9 actions

Keep your Teable tables up to date: add records from forms, sales and emails, update them or add-or-update one matched by a field such as email, find them by a field, a view or a search, and attach files. Start a workflow when a record is added or changed.

Actions

ActionWhat it does
Create or update recordUpdate the record whose value in the field you match on is the one given, such as a contact with this email address, or add it if there is none, so a workflow that runs twice never adds it twice.
Create recordAdd a record to a table, such as a lead from a form, an order or a row from an email, with a value for each field you fill in.
Delete recordDelete one record of a table.
Find recordsFind the records of a table whose field matches a value, that a view shows, or that contain some words, sorted the way you choose.
Get recordRead one record of a table by its ID, with its values.
List projectsList the projects (bases) the token can reach, with the space each is in.
List tablesList a project's tables, with each one's fields, their types and the options of its dropdown fields.
Update recordChange some fields of a record.
Upload attachmentAdd a file, such as an invoice or a photo, to a record's attachment field, after the files already there.

Create or update record

Update the record whose value in the field you match on is the one given, such as a contact with this email address, or add it if there is none, so a workflow that runs twice never adds it twice.

Inputs

Projectproject_idtextRequired
The Teable project (base) the table is in. Pick it from the list, or paste its ID or a link to it from Teable.
Tabletable_idtextRequired
The table to work with, such as Contacts. Pick it from the list, or paste its ID (it starts with tbl) or a link to it from Teable.
Match onmatch_fieldtextRequired
The field that tells records apart, such as Email. Give its value in Fields; it must match exactly, upper and lower case included.
FieldsfieldsobjectRequired
A value for each field to fill in, including the one to match on. An existing record keeps the fields left blank. For a link field, give the linked record's name or ID; for several options or links, separate them with commas.

Outputs

createdtrue/false
True if the record was added, false if an existing one was updated
created_attext
When it was added (ISO 8601)
fieldsobject
The record's values, by field name, such as {"Name": "Ada Lovelace", "Email": "ada@example.com", "Status": "Customer"}. A linked record is {id, title}, an attachment a list of files. Empty fields are left out.
idtext
The record's ID, such as recV3wX4yZ5aB6cD7eF
linktext
Where to open it in Teable
nametext
The value of the table's primary (first) field
table_idtext
The ID of the table it's in, such as tblK8lM9nO0pQ1rS2tU
updated_attext
When it was last changed (ISO 8601)
Example output
{
  "created": true,
  "created_at": "2026-11-05T10:00:00.000Z",
  "fields": {
    "Company": {
      "id": "recQ9wE8rT7yU6iO5pA",
      "title": "Acme Ltd"
    },
    "Deal value": 1500,
    "Email": "ada@example.com",
    "Name": "Ada Lovelace",
    "Status": "Customer",
    "Subscribed": true
  },
  "id": "recV3wX4yZ5aB6cD7eF",
  "link": "https://app.teable.ai/base/bseX7aB2cD3eF4gH5iJ/table/tblK8lM9nO0pQ1rS2tU?recordId=recV3wX4yZ5aB6cD7eF",
  "name": "Ada Lovelace",
  "table_id": "tblK8lM9nO0pQ1rS2tU",
  "updated_at": "2026-11-05T10:05:00.000Z"
}

Create record

Add a record to a table, such as a lead from a form, an order or a row from an email, with a value for each field you fill in.

Inputs

Projectproject_idtextRequired
The Teable project (base) the table is in. Pick it from the list, or paste its ID or a link to it from Teable.
Tabletable_idtextRequired
The table to work with, such as Contacts. Pick it from the list, or paste its ID (it starts with tbl) or a link to it from Teable.
FieldsfieldsobjectRequired
A value for each field to fill in. Fields left blank stay empty. For a link field, give the linked record's name or ID; for several options or links, separate them with commas.

Outputs

created_attext
When it was added (ISO 8601)
fieldsobject
The record's values, by field name, such as {"Name": "Ada Lovelace", "Email": "ada@example.com", "Status": "Customer"}. A linked record is {id, title}, an attachment a list of files. Empty fields are left out.
idtext
The record's ID, such as recV3wX4yZ5aB6cD7eF
linktext
Where to open it in Teable
nametext
The value of the table's primary (first) field
table_idtext
The ID of the table it's in, such as tblK8lM9nO0pQ1rS2tU
updated_attext
When it was last changed (ISO 8601)
Example output
{
  "created_at": "2026-11-05T10:00:00.000Z",
  "fields": {
    "Company": {
      "id": "recQ9wE8rT7yU6iO5pA",
      "title": "Acme Ltd"
    },
    "Deal value": 1500,
    "Email": "ada@example.com",
    "Name": "Ada Lovelace",
    "Status": "Customer",
    "Subscribed": true
  },
  "id": "recV3wX4yZ5aB6cD7eF",
  "link": "https://app.teable.ai/base/bseX7aB2cD3eF4gH5iJ/table/tblK8lM9nO0pQ1rS2tU?recordId=recV3wX4yZ5aB6cD7eF",
  "name": "Ada Lovelace",
  "table_id": "tblK8lM9nO0pQ1rS2tU",
  "updated_at": "2026-11-05T10:05:00.000Z"
}

Delete record

Delete one record of a table. It goes to the table's trash in Teable.

Inputs

Projectproject_idtextRequired
The Teable project (base) the table is in. Pick it from the list, or paste its ID or a link to it from Teable.
Tabletable_idtextRequired
The table to work with, such as Contacts. Pick it from the list, or paste its ID (it starts with tbl) or a link to it from Teable.
Record IDrecord_idtextRequired
The record's ID (it starts with rec), from the trigger or another Teable step, or a link to the record copied from Teable.

Outputs

deletedtrue/false
True once the record is deleted
idtext
The deleted record's ID
table_idtext
The table it was in
Example output
{
  "deleted": true,
  "id": "recV3wX4yZ5aB6cD7eF",
  "table_id": "tblK8lM9nO0pQ1rS2tU"
}

Find records

Find the records of a table whose field matches a value, that a view shows, or that contain some words, sorted the way you choose. Leave the filter blank to list them all, a page at a time.

Inputs

Projectproject_idtextRequired
The Teable project (base) the table is in. Pick it from the list, or paste its ID or a link to it from Teable.
Tabletable_idtextRequired
The table to work with, such as Contacts. Pick it from the list, or paste its ID (it starts with tbl) or a link to it from Teable.
Viewview_idtext
Only the records this view shows, in its order. Leave blank for the whole table.
Filter by fieldfilter_fieldtext
Only records whose value in this field passes the filter.
Filterfilter_operatortext
How the field's value is compared. Is matches exactly, upper and lower case included; Contains ignores case.One of: equals (Is), not_equals (Is not), contains, does_not_contain (Does not contain), greater_than (Greater than (after, for dates)), at_least (Greater than or equal to (on or after)), less_than (Less than (before, for dates)), at_most (Less than or equal to (on or before)), one_of (Is any of), empty (Is empty), not_empty (Is not empty). Default: equals.
Filter valuefilter_valuetext
The value to compare with: a date as 2026-11-05, a checkbox as yes or no, a linked record by its name or ID. For Is any of, separate the values with commas.Only when Filter is Is, Is not, Contains, Does not contain, Greater than (after, for dates), Greater than or equal to (on or after), Less than (before, for dates), Less than or equal to (on or before) or Is any of.
Advanced filteradvanced_filtertext
A Teable filter in JSON, for several conditions at once, such as {"conjunction": "and", "filterSet": [{"fieldId": "Status", "operator": "is", "value": "Customer"}]}. Used together with Filter by field.
Searchsearchtext
Only records with these words in any of their fields.
Sort bysort_fieldtext
The field to sort the records by. Leave blank for the view's order, or the order they were added.
Newest or highest firstdescendingtrue/false
Sort from highest to lowest (newest first, Z to A).Default: false.
How manylimitnumber
The most records to return, up to 1000. Defaults to 100.From 1 to 1000.
Pagepagenumber
Which page of results to return, starting at 1.At least 1.
Fields to returnreturn_fieldslist
Return only these fields. Leave empty for all of them.

Outputs

countnumber
How many records are listed
idslist
The IDs of the records listed
recordslist
The records that match, each with its values by field name
table_idtext
The table searched
totalnumber
How many records match in all, across every page
Example output
{
  "count": 1,
  "ids": [
    "recV3wX4yZ5aB6cD7eF"
  ],
  "records": [
    {
      "created_at": "2026-11-05T10:00:00.000Z",
      "fields": {
        "Company": {
          "id": "recQ9wE8rT7yU6iO5pA",
          "title": "Acme Ltd"
        },
        "Deal value": 1500,
        "Email": "ada@example.com",
        "Name": "Ada Lovelace",
        "Status": "Customer",
        "Subscribed": true
      },
      "id": "recV3wX4yZ5aB6cD7eF",
      "link": "https://app.teable.ai/base/bseX7aB2cD3eF4gH5iJ/table/tblK8lM9nO0pQ1rS2tU?recordId=recV3wX4yZ5aB6cD7eF",
      "name": "Ada Lovelace",
      "table_id": "tblK8lM9nO0pQ1rS2tU",
      "updated_at": "2026-11-05T10:05:00.000Z"
    }
  ],
  "table_id": "tblK8lM9nO0pQ1rS2tU",
  "total": 1
}

Get record

Read one record of a table by its ID, with its values.

Inputs

Projectproject_idtextRequired
The Teable project (base) the table is in. Pick it from the list, or paste its ID or a link to it from Teable.
Tabletable_idtextRequired
The table to work with, such as Contacts. Pick it from the list, or paste its ID (it starts with tbl) or a link to it from Teable.
Record IDrecord_idtextRequired
The record's ID (it starts with rec), from the trigger or another Teable step, or a link to the record copied from Teable.
Fields to returnreturn_fieldslist
Return only these fields. Leave empty for all of them.

Outputs

created_attext
When it was added (ISO 8601)
fieldsobject
The record's values, by field name, such as {"Name": "Ada Lovelace", "Email": "ada@example.com", "Status": "Customer"}. A linked record is {id, title}, an attachment a list of files. Empty fields are left out.
idtext
The record's ID, such as recV3wX4yZ5aB6cD7eF
linktext
Where to open it in Teable
nametext
The value of the table's primary (first) field
table_idtext
The ID of the table it's in, such as tblK8lM9nO0pQ1rS2tU
updated_attext
When it was last changed (ISO 8601)
Example output
{
  "created_at": "2026-11-05T10:00:00.000Z",
  "fields": {
    "Company": {
      "id": "recQ9wE8rT7yU6iO5pA",
      "title": "Acme Ltd"
    },
    "Deal value": 1500,
    "Email": "ada@example.com",
    "Name": "Ada Lovelace",
    "Status": "Customer",
    "Subscribed": true
  },
  "id": "recV3wX4yZ5aB6cD7eF",
  "link": "https://app.teable.ai/base/bseX7aB2cD3eF4gH5iJ/table/tblK8lM9nO0pQ1rS2tU?recordId=recV3wX4yZ5aB6cD7eF",
  "name": "Ada Lovelace",
  "table_id": "tblK8lM9nO0pQ1rS2tU",
  "updated_at": "2026-11-05T10:05:00.000Z"
}

List projects

List the projects (bases) the token can reach, with the space each is in.

Inputs

None.

Outputs

countnumber
How many projects there are
projectslist
The projects the token can reach
Example output
{
  "count": 1,
  "projects": [
    {
      "id": "bseX7aB2cD3eF4gH5iJ",
      "link": "https://app.teable.ai/base/bseX7aB2cD3eF4gH5iJ",
      "name": "Sales CRM",
      "role": "owner",
      "space_id": "spcA1bC2dE3fG4hI5jK",
      "space_name": "Acme"
    }
  ]
}

List tables

List a project's tables, with each one's fields, their types and the options of its dropdown fields.

Inputs

Projectproject_idtextRequired
The Teable project (base) the table is in. Pick it from the list, or paste its ID or a link to it from Teable.

Outputs

countnumber
How many tables there are
project_idtext
The project the tables are in
tableslist
The project's tables
Example output
{
  "count": 1,
  "project_id": "bseX7aB2cD3eF4gH5iJ",
  "tables": [
    {
      "description": "",
      "fields": [
        {
          "id": "fld7XDtTMfMpw2OocdH",
          "name": "Name",
          "options": [],
          "required": false,
          "type": "singleLineText",
          "writable": true
        },
        {
          "id": "fldJ7hR6eLHWtFroYiA",
          "name": "Status",
          "options": [
            "Lead",
            "Customer"
          ],
          "required": false,
          "type": "singleSelect",
          "writable": true
        },
        {
          "id": "fldaXgMzNXTdsSB72Vo",
          "name": "Created",
          "options": [],
          "required": false,
          "type": "createdTime",
          "writable": false
        }
      ],
      "id": "tblK8lM9nO0pQ1rS2tU",
      "link": "https://app.teable.ai/base/bseX7aB2cD3eF4gH5iJ/table/tblK8lM9nO0pQ1rS2tU",
      "name": "Contacts",
      "primary_field": "Name",
      "required_fields": []
    }
  ]
}

Update record

Change some fields of a record. Fields left blank keep their value.

Inputs

Projectproject_idtextRequired
The Teable project (base) the table is in. Pick it from the list, or paste its ID or a link to it from Teable.
Tabletable_idtextRequired
The table to work with, such as Contacts. Pick it from the list, or paste its ID (it starts with tbl) or a link to it from Teable.
Record IDrecord_idtextRequired
The record's ID (it starts with rec), from the trigger or another Teable step, or a link to the record copied from Teable.
FieldsfieldsobjectRequired
The new value for each field to change. Fields left blank keep their value. For a link field, give the linked record's name or ID; for several options or links, separate them with commas.

Outputs

created_attext
When it was added (ISO 8601)
fieldsobject
The record's values, by field name, such as {"Name": "Ada Lovelace", "Email": "ada@example.com", "Status": "Customer"}. A linked record is {id, title}, an attachment a list of files. Empty fields are left out.
idtext
The record's ID, such as recV3wX4yZ5aB6cD7eF
linktext
Where to open it in Teable
nametext
The value of the table's primary (first) field
table_idtext
The ID of the table it's in, such as tblK8lM9nO0pQ1rS2tU
updated_attext
When it was last changed (ISO 8601)
Example output
{
  "created_at": "2026-11-05T10:00:00.000Z",
  "fields": {
    "Company": {
      "id": "recQ9wE8rT7yU6iO5pA",
      "title": "Acme Ltd"
    },
    "Deal value": 1500,
    "Email": "ada@example.com",
    "Name": "Ada Lovelace",
    "Status": "Customer",
    "Subscribed": true
  },
  "id": "recV3wX4yZ5aB6cD7eF",
  "link": "https://app.teable.ai/base/bseX7aB2cD3eF4gH5iJ/table/tblK8lM9nO0pQ1rS2tU?recordId=recV3wX4yZ5aB6cD7eF",
  "name": "Ada Lovelace",
  "table_id": "tblK8lM9nO0pQ1rS2tU",
  "updated_at": "2026-11-05T10:05:00.000Z"
}

Upload attachment

Add a file, such as an invoice or a photo, to a record's attachment field, after the files already there.

Inputs

Projectproject_idtextRequired
The Teable project (base) the table is in. Pick it from the list, or paste its ID or a link to it from Teable.
Tabletable_idtextRequired
The table to work with, such as Contacts. Pick it from the list, or paste its ID (it starts with tbl) or a link to it from Teable.
Record IDrecord_idtextRequired
The record's ID (it starts with rec), from the trigger or another Teable step, or a link to the record copied from Teable.
Attachment fieldattachment_fieldtextRequired
The record's attachment field to add the file to.
FilefiletextRequired
The file: upload one, pick one from an earlier step, or give a public https link to download.
File namefile_nametext
What the file is called in Teable, such as invoice.pdf. Defaults to its own name.

Outputs

attachmentobject
The file just added
attachment_countnumber
How many files the field holds now
created_attext
When it was added (ISO 8601)
fieldsobject
The record's values, by field name, such as {"Name": "Ada Lovelace", "Email": "ada@example.com", "Status": "Customer"}. A linked record is {id, title}, an attachment a list of files. Empty fields are left out.
idtext
The record's ID, such as recV3wX4yZ5aB6cD7eF
linktext
Where to open it in Teable
nametext
The value of the table's primary (first) field
table_idtext
The ID of the table it's in, such as tblK8lM9nO0pQ1rS2tU
updated_attext
When it was last changed (ISO 8601)
Example output
{
  "attachment": {
    "id": "actYzGwJjCwmiDDujSm",
    "name": "invoice-1042.pdf",
    "size": 48213,
    "type": "application/pdf",
    "url": "https://app.teable.ai/api/attachments/read/private/table/5y9VzlpXln6b?token=..."
  },
  "attachment_count": 1,
  "created_at": "2026-11-05T10:00:00.000Z",
  "fields": {
    "Company": {
      "id": "recQ9wE8rT7yU6iO5pA",
      "title": "Acme Ltd"
    },
    "Deal value": 1500,
    "Email": "ada@example.com",
    "Files": [
      {
        "id": "actYzGwJjCwmiDDujSm",
        "mimetype": "application/pdf",
        "name": "invoice-1042.pdf",
        "size": 48213
      }
    ],
    "Name": "Ada Lovelace",
    "Status": "Customer",
    "Subscribed": true
  },
  "id": "recV3wX4yZ5aB6cD7eF",
  "link": "https://app.teable.ai/base/bseX7aB2cD3eF4gH5iJ/table/tblK8lM9nO0pQ1rS2tU?recordId=recV3wX4yZ5aB6cD7eF",
  "name": "Ada Lovelace",
  "table_id": "tblK8lM9nO0pQ1rS2tU",
  "updated_at": "2026-11-05T10:05:00.000Z"
}

On this page