AITable

App · 19 actions

Work with your AITable spaces: find datasheets, create datasheets and fields, list, search, create, update and delete records, and upload files for attachment fields.

Actions

ActionWhat it does
Create datasheetCreate a datasheet in a space, at the top or in a folder, with text fields of the names you give.
Create fieldAdd a field (column) to a datasheet: text, number, currency, percent, date, checkbox, rating, select, website, phone, email or attachment.
Create recordAdd a record to a datasheet.
Create recordsAdd up to 10 records in one step.
Delete fieldDelete a field and every value stored in it.
Delete recordDelete a record from a datasheet.
Delete recordsDelete up to 10 records in one step, given their ids.
Find filesFind datasheets, folders, forms, dashboards or mirrors anywhere in a space by part of their name, whatever folder they are in.
Get fileGet one datasheet, folder, form or dashboard; for a folder, also the files directly inside it.
Get recordGet one record with all of its values.
List fieldsList a datasheet's fields with their types, settings and which is the primary one; optionally as one view shows them.
List files in a spaceList the datasheets, folders, forms and dashboards at the top of a space.
List recordsList a datasheet's records, a page at a time, optionally from one view, filtered by a formula or sorted by a field.
List spacesList the spaces you own or were invited to, with your admin status in each.
List viewsList a datasheet's views (grid, gallery, kanban and so on).
Search recordsFind records whose chosen field contains, equals or starts with some text, ignoring case.
Update recordChange some fields of a record.
Update recordsChange up to 10 records in one step.
Upload attachmentUpload a file to a datasheet.

Create datasheet

Create a datasheet in a space, at the top or in a folder, with text fields of the names you give. The first is the primary field. With none, AITable adds three default fields.

Inputs

Spacespace_idtextRequired
The space. Pick one, or give its id from an earlier step.
NamenametextRequired
The datasheet's name, at most 100 characters.
Descriptiondescriptiontext
What the datasheet is for, at most 500 characters.
Folderfolder_idtext
Where to put it. Leave empty for the top of the space.
Field namesfield_nameslist
The names of the text fields to start with, one per row. Other field types can be added afterwards.

Outputs

created_attext
When it was created (UTC)
datasheet_idtext
The new datasheet's id, to use as datasheet_id in other steps
fieldslist
The fields it starts with
nametext
The datasheet's name
Example output
{
  "created_at": "2026-10-15T09:00:00Z",
  "datasheet_id": "dstbs2U7mt8AEqgKuh",
  "fields": [
    {
      "id": "fldupsvkR2ATB",
      "name": "Title"
    }
  ],
  "name": "Customers"
}

Create field

Add a field (column) to a datasheet: text, number, currency, percent, date, checkbox, rating, select, website, phone, email or attachment. Only managers of the datasheet can add fields.

Inputs

Spacespace_idtextRequired
The space. Pick one, or give its id from an earlier step.
Datasheetdatasheet_idtextRequired
The datasheet in that space. Pick one or give its id.
Field namenametextRequired
The new field's name, at most 100 characters.
Typefield_typetextRequired
What the field holds. It cannot be changed from a step later.One of: SingleText (Single-line text), Text (Long text), Number, Currency, Percent, DateTime (Date), Checkbox, Rating, SingleSelect (Single select), MultiSelect (Multiple select), and 4 more.
Choicesoptionslist
The choices people can pick from, one per row.Only when Type is Single select or Multiple select.
Decimal placesprecisionnumber
How many decimals to show, 0 to 4. Currency defaults to 2.Only when Type is Number, Currency or Percent. From 0 to 4.
Unit or currency symbolsymboltext
Shown beside the value, such as $ or kg. Currency defaults to $.Only when Type is Number or Currency.
Highest ratingrating_maxnumber
The top of the scale, 1 to 10. The default is 5.Only when Type is Rating. From 1 to 10.
Include timeinclude_timetrue/false
Store a time of day as well as the date.Only when Type is Date. Default: false.

Outputs

field_idtext
The new field's id, to use as field_id in other steps
nametext
The field's name
typetext
The field's type
Example output
{
  "field_id": "fldupsvkR2ATB",
  "name": "Status",
  "type": "SingleSelect"
}

Create record

Add a record to a datasheet. Fields left empty stay blank; text is turned into numbers, checkboxes, choices and dates for the field's type.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
FieldsfieldsobjectRequired
The value for each field. Leave a field empty to leave it out; calculated fields are not offered.

Outputs

created_attext
When it was created (UTC)
fieldsobject
The record's values by field name
record_idtext
The record's id, to use as record_id in other steps
updated_attext
When it last changed (UTC)
Example output
{
  "created_at": "2026-10-15T09:00:00Z",
  "fields": {
    "Title": "Acme"
  },
  "record_id": "recV3ElniQavTNyJG",
  "updated_at": "2026-10-15T09:00:00Z"
}

Create records

Add up to 10 records in one step. Give a list with one object of field names and values per record.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
RecordsrecordslistRequired
A list of up to 10 objects, each a record's values by field name, such as [{"Name": "Ada"}, {"Name": "Grace"}].

Outputs

countnumber
How many were returned
recordslist
The records
Example output
{
  "count": 1,
  "records": [
    {
      "created_at": "2026-10-15T09:00:00Z",
      "fields": {
        "Title": "Acme"
      },
      "record_id": "recV3ElniQavTNyJG",
      "updated_at": "2026-10-15T09:00:00Z"
    }
  ]
}

Delete field

Delete a field and every value stored in it. Only managers of the datasheet can delete fields, and the primary field cannot be deleted.

Inputs

Spacespace_idtextRequired
The space. Pick one, or give its id from an earlier step.
Datasheetdatasheet_idtextRequired
The datasheet in that space. Pick one or give its id.
Fieldfield_idtextRequired
The field to delete. Pick one, or give its id from 'Create field'.

Outputs

deletedtrue/false
Always true once deleted
field_idtext
The field deleted
Example output
{
  "deleted": true,
  "field_id": "fldupsvkR2ATB"
}

Delete record

Delete a record from a datasheet. Editors and managers can delete records.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
Record IDrecord_idtextRequired
The record's id, from 'List records', 'Search records' or a create step.

Outputs

deletedtrue/false
Always true once deleted
record_idtext
The record deleted
Example output
{
  "deleted": true,
  "record_id": "recV3ElniQavTNyJG"
}

Delete records

Delete up to 10 records in one step, given their ids.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
Record IDsrecord_idslistRequired
Up to 10 record ids, one per row, from a list or search step.

Outputs

countnumber
How many were deleted
deletedtrue/false
Always true once deleted
record_idslist
The ids deleted
Example output
{
  "count": 1,
  "deleted": true,
  "record_ids": [
    "recV3ElniQavTNyJG"
  ]
}

Find files

Find datasheets, folders, forms, dashboards or mirrors anywhere in a space by part of their name, whatever folder they are in.

Inputs

Spacespace_idtextRequired
The space. Pick one, or give its id from an earlier step.
Kind of filenode_typetextRequired
Which kind of file to find.One of: Datasheet, Folder, Form, Dashboard, Mirror.
Name containsquerytext
Part of the name. Leave empty for every file of that kind.
Only filesaccesstext
Limit to files you can edit. Defaults to any access.One of: any (Any access (default)), add_records (I can add records), edit_structure (I can manage or edit it).

Outputs

countnumber
How many were returned
nodeslist
The matching files
Example output
{
  "count": 1,
  "nodes": [
    {
      "icon": "",
      "id": "dstbs2U7mt8AEqgKuh",
      "is_favorite": false,
      "name": "Customers",
      "parent_id": "",
      "permission": 0,
      "type": "Datasheet"
    }
  ]
}

Get file

Get one datasheet, folder, form or dashboard; for a folder, also the files directly inside it.

Inputs

Spacespace_idtextRequired
The space. Pick one, or give its id from an earlier step.
Filenode_idtextRequired
The file or folder. Pick one at the top of the space, or give its id.

Outputs

childrenlist
The files inside, for a folder
children_countnumber
How many files are inside
nodeobject
The file
Example output
{
  "children": [],
  "children_count": 0,
  "node": {
    "icon": "",
    "id": "dstbs2U7mt8AEqgKuh",
    "is_favorite": false,
    "name": "Customers",
    "parent_id": "",
    "permission": 0,
    "type": "Datasheet"
  }
}

Get record

Get one record with all of its values.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
Record IDrecord_idtextRequired
The record's id, from 'List records', 'Search records' or a create step.

Outputs

created_attext
When it was created (UTC)
fieldsobject
The record's values by field name
record_idtext
The record's id, to use as record_id in other steps
updated_attext
When it last changed (UTC)
Example output
{
  "created_at": "2026-10-15T09:00:00Z",
  "fields": {
    "Title": "Acme"
  },
  "record_id": "recV3ElniQavTNyJG",
  "updated_at": "2026-10-15T09:00:00Z"
}

List fields

List a datasheet's fields with their types, settings and which is the primary one; optionally as one view shows them.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
Viewview_idtext
Only the fields this view shows, in its order.

Outputs

countnumber
How many were returned
fieldslist
The fields
Example output
{
  "count": 1,
  "fields": [
    {
      "description": "",
      "editable": true,
      "id": "fldupsvkR2ATB",
      "is_primary": true,
      "name": "Title",
      "property": {
        "defaultValue": ""
      },
      "type": "SingleText"
    }
  ]
}

List files in a space

List the datasheets, folders, forms and dashboards at the top of a space. To look inside a folder, use 'Get file'.

Inputs

Spacespace_idtextRequired
The space. Pick one, or give its id from an earlier step.

Outputs

countnumber
How many were returned
nodeslist
The files and folders
Example output
{
  "count": 1,
  "nodes": [
    {
      "icon": "",
      "id": "dstbs2U7mt8AEqgKuh",
      "is_favorite": false,
      "name": "Customers",
      "parent_id": "",
      "permission": 0,
      "type": "Datasheet"
    }
  ]
}

List records

List a datasheet's records, a page at a time, optionally from one view, filtered by a formula or sorted by a field. Gets one page; for more, run it again with the next page number.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
Viewview_idtext
Only the records and fields this view shows, in its order.
Filter formulafilter_formulatext
Only records where this AITable formula is true, such as {Status}="Done". To match text without a formula, use 'Search records'.
Sort bysort_fieldtext
The field to sort by. Leave empty for the view's own order.
Sort ordersort_ordertext
Which way to sort. Needs a field to sort by.One of: asc (Ascending (default)), desc (Descending).
Values ascell_formattext
Values as stored (numbers, lists, dates as timestamps), or every value as the text AITable shows.One of: json (Values (default)), string (Text, as shown in AITable).
Page sizepage_sizenumber
How many records per page, 1 to 1000. The default is 100.From 1 to 1000.
Pagepage_numbernumber
Which page to get, starting at 1. The default is 1.At least 1.
Stop aftermax_recordsnumber
The most records to return in total, whatever the page size.At least 1.

Outputs

countnumber
How many are on this page
has_moretrue/false
True when a later page has more records
page_numbernumber
This page's number
page_sizenumber
Records per page
recordslist
The records
totalnumber
How many records match in all
Example output
{
  "count": 1,
  "has_more": false,
  "page_number": 1,
  "page_size": 100,
  "records": [
    {
      "created_at": "2026-10-15T09:00:00Z",
      "fields": {
        "Title": "Acme"
      },
      "record_id": "recV3ElniQavTNyJG",
      "updated_at": "2026-10-15T09:00:00Z"
    }
  ],
  "total": 1
}

List spaces

List the spaces you own or were invited to, with your admin status in each.

Inputs

None.

Outputs

countnumber
How many were returned
spaceslist
The spaces
Example output
{
  "count": 1,
  "spaces": [
    {
      "id": "spcjXzqVrjaP3",
      "is_admin": true,
      "name": "Lodol"
    }
  ]
}

List views

List a datasheet's views (grid, gallery, kanban and so on).

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.

Outputs

countnumber
How many were returned
viewslist
The views
Example output
{
  "count": 1,
  "views": [
    {
      "id": "viwpdA8TUBp5r",
      "name": "Grid view",
      "type": "Grid"
    }
  ]
}

Search records

Find records whose chosen field contains, equals or starts with some text, ignoring case. Reads up to 5,000 rows and says when it stopped early.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
Fieldsearch_fieldtextRequired
The field whose value is compared. Pick one or type its name.
Matchmatchtext
How the field must match the text. Case is ignored.One of: contains (Contains (default)), equals (Is exactly), starts_with (Starts with).
Text to findvaluetextRequired
The text to look for in that field.
Most resultsmax_resultsnumber
The most matches to return, 1 to 1000. The default is 100.From 1 to 1000.

Outputs

countnumber
How many matched
recordslist
The matching records, with values as text
scannednumber
How many rows were read
truncatedtrue/false
True when more rows may match than are shown
Example output
{
  "count": 1,
  "records": [
    {
      "created_at": "2026-10-15T09:00:00Z",
      "fields": {
        "Title": "Acme"
      },
      "record_id": "recV3ElniQavTNyJG",
      "updated_at": "2026-10-15T09:00:00Z"
    }
  ],
  "scanned": 1,
  "truncated": false
}

Update record

Change some fields of a record. Fields left empty keep their values; a value can't be cleared from here.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
Record IDrecord_idtextRequired
The record's id, from 'List records', 'Search records' or a create step.
FieldsfieldsobjectRequired
The value for each field. Leave a field empty to leave it out; calculated fields are not offered.

Outputs

created_attext
When it was created (UTC)
fieldsobject
The record's values by field name
record_idtext
The record's id, to use as record_id in other steps
updated_attext
When it last changed (UTC)
Example output
{
  "created_at": "2026-10-15T09:00:00Z",
  "fields": {
    "Title": "Acme"
  },
  "record_id": "recV3ElniQavTNyJG",
  "updated_at": "2026-10-15T09:00:00Z"
}

Update records

Change up to 10 records in one step. Give a list with one object per record: its record_id and the fields to change.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
RecordsrecordslistRequired
A list of up to 10 objects, each with a record_id and the values to change, such as [{"record_id": "rec123", "Status": "Done"}].

Outputs

countnumber
How many were returned
recordslist
The records
Example output
{
  "count": 1,
  "records": [
    {
      "created_at": "2026-10-15T09:00:00Z",
      "fields": {
        "Title": "Acme"
      },
      "record_id": "recV3ElniQavTNyJG",
      "updated_at": "2026-10-15T09:00:00Z"
    }
  ]
}

Upload attachment

Upload a file to a datasheet. It is not on any record until you give this step's 'attachments' to an attachment field in 'Create record' or 'Update record'. One file per step; a space holds 1 GB in all.

Inputs

Datasheetdatasheet_idtextRequired
The datasheet. Pick one, give its id from an earlier step, or paste its address from the browser.
FilefiletextRequired
Upload a file, pick one from an earlier step, or paste a link to one.
File namefile_nametext
What to call the file in AITable, such as invoice.pdf. Leave blank to keep its own name.

Outputs

attachmentobject
The uploaded file as AITable describes it
attachmentslist
A list holding the file, to give to an attachment field
nametext
The file's name
tokentext
The file's token
Example output
{
  "attachment": {
    "height": 478,
    "mimeType": "image/png",
    "name": "logo.png",
    "preview": "",
    "size": 7194,
    "token": "space/2026/10/15/6fdc652231a8480398e302606ae28213",
    "url": "https://s1.aitable.ai/space/2026/10/15/6fdc652231a8480398e302606ae28213",
    "width": 479
  },
  "attachments": [
    {
      "height": 478,
      "mimeType": "image/png",
      "name": "logo.png",
      "preview": "",
      "size": 7194,
      "token": "space/2026/10/15/6fdc652231a8480398e302606ae28213",
      "url": "https://s1.aitable.ai/space/2026/10/15/6fdc652231a8480398e302606ae28213",
      "width": 479
    }
  ],
  "name": "logo.png",
  "token": "space/2026/10/15/6fdc652231a8480398e302606ae28213"
}

On this page