For the complete documentation index, see llms.txt. This page is also available as Markdown.

Data Table

Operations about data tables and their rows

List all data tables

get

Retrieve a list of all data tables with optional filtering, sorting, and pagination.

Authorizations
X-N8N-API-KEYstringRequired
Query parameters
limitnumber · max: 250Optional

The maximum number of items to return.

Default: 100Example: 100
cursorstringOptional

Paginate by setting the cursor parameter to the nextCursor attribute returned by the previous request's response. Default value fetches the first "page" of the collection. See pagination for more detail.

filterstring · jsonStringOptional

JSON string of filter conditions

Example: {"name":"my-table"}
sortBystringOptional

Sort format: field:asc or field:desc

Example: name:asc
Responses
200

Successfully retrieved data tables

application/json
nextCursorstring · nullableOptional

Paginate through data tables by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection.

Example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA
get/data-tables

Create a new data table

post

Create a new data table in your personal project or a team project you have access to.

Authorizations
X-N8N-API-KEYstringRequired
Body
namestring · min: 1 · max: 128Required

Name of the data table

projectIdstringOptional

ID of the project to create the table in. When omitted, the table is created in the user's personal project.

Responses
201

Data table created successfully

application/json
idstringRequired

Unique identifier for the data table

namestringRequired

Name of the data table

projectIdstringRequired

ID of the project this table belongs to

createdAtstring · date-timeRequired

Timestamp when the table was created

updatedAtstring · date-timeRequired

Timestamp when the table was last updated

post/data-tables

Get a data table

get

Retrieve a specific data table by ID.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Responses
200

Successfully retrieved data table

application/json
idstringRequired

Unique identifier for the data table

namestringRequired

Name of the data table

projectIdstringRequired

ID of the project this table belongs to

createdAtstring · date-timeRequired

Timestamp when the table was created

updatedAtstring · date-timeRequired

Timestamp when the table was last updated

get/data-tables/{dataTableId}

Delete a data table

delete

Delete a data table. This will also delete all rows in the table.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Responses
204

Data table deleted successfully

No content

delete/data-tables/{dataTableId}

No content

Update a data table

patch

Update a data table's name.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Body
namestring · min: 1 · max: 128Required

New name for the data table

Responses
200

Data table updated successfully

application/json
idstringRequired

Unique identifier for the data table

namestringRequired

Name of the data table

projectIdstringRequired

ID of the project this table belongs to

createdAtstring · date-timeRequired

Timestamp when the table was created

updatedAtstring · date-timeRequired

Timestamp when the table was last updated

patch/data-tables/{dataTableId}

Retrieve rows from a data table

get

Query and retrieve rows from a data table with optional filtering, sorting, and pagination.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Query parameters
limitnumber · max: 250Optional

The maximum number of items to return.

Default: 100Example: 100
cursorstringOptional

Paginate by setting the cursor parameter to the nextCursor attribute returned by the previous request's response. Default value fetches the first "page" of the collection. See pagination for more detail.

filterstring · jsonStringOptional

JSON string of filter conditions

Example: {"type":"and","filters":[{"columnName":"status","condition":"eq","value":"active"}]}
sortBystringOptional

Sort format: columnName:asc or columnName:desc

Example: createdAt:desc
searchstringOptional

Search text across all string columns

Responses
200

Successfully retrieved rows

application/json
nextCursorstring · nullableOptional

Paginate through rows by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection.

Example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA
get/data-tables/{dataTableId}/rows

Insert rows into a data table

post

Insert one or more rows into a data table.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Body
returnTypestring · enumOptional
  • count: Return only the number of rows inserted
  • id: Return an array of inserted row IDs
  • all: Return the full row data for all inserted rows
Default: countPossible values:
Responses
200

Rows inserted successfully

application/json
or
integer[]Optional

Array of inserted row IDs (when returnType is 'id')

or
post/data-tables/{dataTableId}/rows

Update rows in a data table

patch

Update rows matching filter conditions in a data table.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Body
returnDatabooleanOptional

If true, return the updated rows; if false, return true on success

Default: false
dryRunbooleanOptional

If true, preview changes without persisting them

Default: false
Responses
200

Rows updated successfully

application/json
booleanOptional

True when returnData is false

or
patch/data-tables/{dataTableId}/rows/update

Upsert a row in a data table

post

Update an existing row or insert a new one if no row matches the filter conditions.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Body
returnDatabooleanOptional

If true, return the upserted row; if false, return true on success

Default: false
dryRunbooleanOptional

If true, preview changes without persisting them

Default: false
Responses
200

Row upserted successfully

application/json
booleanOptional

True when returnData is false

or
post/data-tables/{dataTableId}/rows/upsert

Clear all rows from a data table

delete

Permanently deletes all rows from a data table. The table structure will be retained. This action cannot be undone.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Responses
200

Rows cleared successfully

application/json
deletedCountintegerOptional

The number of rows that were deleted

delete/data-tables/{dataTableId}/rows/clear

Delete rows from a data table

delete

Delete rows matching filter conditions from a data table. Filter is required to prevent accidental deletion of all data.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Query parameters
filterstring · jsonStringRequired

JSON string of filter conditions. Required to prevent accidental deletion of all data.

Example: {"type":"and","filters":[{"columnName":"status","condition":"eq","value":"archived"}]}
returnDatabooleanOptional

If true, return the deleted rows; if false, return true on success

Default: false
dryRunbooleanOptional

If true, preview which rows would be deleted without actually deleting them

Default: false
Responses
200

Rows deleted successfully

application/json
booleanOptional

True when returnData is false

or
delete/data-tables/{dataTableId}/rows/delete

List columns of a data table

get

Retrieve all columns for a specific data table.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Responses
200

Successfully retrieved columns

application/json
idstringRequired

Column ID

namestringRequired

Column name

dataTableIdstringRequired

ID of the data table this column belongs to

typestring · enumRequired

Column data type

Possible values:
indexintegerRequired

Column position

get/data-tables/{dataTableId}/columns

Add a column to a data table

post

Add a new column to an existing data table.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

Body
namestring · min: 1 · max: 63Required

Column name. Must start with a letter; only letters, digits, and underscores after that; maximum 63 characters.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
typestring · enumRequired

Column data type

Possible values:
indexintegerOptional

Column position (optional, appended to end if omitted)

Responses
201

Column created successfully

application/json
idstringRequired

Column ID

namestringRequired

Column name

dataTableIdstringRequired

ID of the data table this column belongs to

typestring · enumRequired

Column data type

Possible values:
indexintegerRequired

Column position

post/data-tables/{dataTableId}/columns

Delete a column

delete

Remove a column from a data table. This will also delete all data in the column.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

columnIdstring · nanoidRequired

The ID of the column

Responses
204

Column deleted successfully

No content

delete/data-tables/{dataTableId}/columns/{columnId}

No content

Update a column

patch

Rename and/or reorder a column in a data table.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
dataTableIdstring · nanoidRequired

The ID of the data table

columnIdstring · nanoidRequired

The ID of the column

Body
anyOptional
or
anyOptional
Responses
200

Column updated successfully

application/json
idstringRequired

Column ID

namestringRequired

Column name

dataTableIdstringRequired

ID of the data table this column belongs to

typestring · enumRequired

Column data type

Possible values:
indexintegerRequired

Column position

patch/data-tables/{dataTableId}/columns/{columnId}

Last updated

Was this helpful?