Skip to content

Grist#

The Grist node allows you to automate work in Grist, and integrate Grist with other applications. n8n has built-in support for a wide range of Grist features, including creating, updating, deleting, and reading rows in a table.

On this page, you'll find a list of operations the Grist node supports and links to more resources.

Credentials

Refer to Grist credentials for guidance on setting up authentication.

Examples and templates

For usage examples and templates to help you get started, take a look at n8n's Grist integrations list.

Basic operations#

  • Create rows in a table
  • Delete rows from a table
  • Read rows from a table
  • Update rows in a table

Example usage#

This workflow allows you to insert and update data from a table in Grist. You can also find the workflow on n8n.io. This example usage workflow uses the following nodes:

The final workflow should look like the following:

A workflow with the Grist node

1. Start node#

The start node exists by default when you create a new workflow.

2. Grist node (Create)#

This workflow assumes there is a document with a table in your Grist workspace.

Table in an example Grist document

This node will create a new record in a table.

  1. First enter your credentials for the Grist node. You can find out how to do that here.
  2. Select 'Create' from the Operation dropdown list.
  3. Enter that ID of your document into the Document ID field.
  4. Enter the ID of your table in the Table ID field.
  5. Under Fields to Send click the Add Field button twice.
  6. For the first field, choose Name from the Field ID dropdown, and type a name in the Field Value.
  7. For the second field, choose Link from the Field ID dropdown, and enter a URL in the Field Value.
  8. Click on Execute Node to run the node.

Here is an example of how the configuration should look:

Using the Grist node to insert data into an Grist table

And here's the result of adding the record to the Grist table:

The example table after creating a new record with the Grist node

3. Grist1 node (Get All)#

This node will list all the records with a particular Name value.

  1. Select the credentials that you entered in the previous node.
  2. Select the 'Get All' option from the Operation dropdown list.
  3. Click on the gears icon next to the Document ID field and click on Add Expression.
  4. Select the following in the Variable Selector section: Nodes > Grist > Parameters > docId.
  5. Click on the gears icon next to the Table field and click on Add Expression.
  6. Select the following in the Variable Selector section: Nodes > Grist > Parameters > tableId.
  7. Click on Add Option and select 'Filter' from the dropdown list.
  8. Click the Add Filter button.
  9. Select Name from the Column dropdown.
  10. Type a name in the Values field.
  11. Click on Execute Node to run the node.

In the screenshot below, the node only returned the record with the name 'Grist':

Using the Grist node to read data from an Grist table

4. Grist2 node (Update)#

This node will update the Name field of the record that we received from the previous Grist node.

  1. Select the Grist1 node in your workflow and click 'Duplicate Node'. Now you won't need to specify the credentials, Document ID, and Table ID again.
  2. Double click the newly duplicated node (Grist2) to edit it.
  3. Select 'Update' from the Operation dropdown list.
  4. Click on the gears icon next to the Row ID field and click on Add Expression.
  5. Select the following in the Variable Selector section: Nodes > Grist1 > Output Data > JSON > id.
  6. Under Fields to Send click the Add Field button.
  7. Choose Name from the Field ID dropdown, and type a name in the Field Value.
  8. Click on Execute Node to run the node.

Here is an example of how the configuration should look:

Using the Grist node to update data of a record

The result is that the Name in the first record changed from 'Grist' to 'Grist Labs':

The example table after updating a record with the Grist node

FAQs#

How to get the Row ID?#

To update or delete a particular record, you need the Row ID. There are two ways to get the Row ID.

Create a Row ID column in Grist

Create a new column in your Grist table with the formula $id.

Use the Get All operation

The Get All operation returns the Row ID of each record along with the fields.

You can obtain it with the expression {{$node["GristNodeName"].json["id"]}}.

How to filter records when using the Get All operation?#

  • Click on Add Option and select 'Filter' from the dropdown list.
  • You can add filters for any number of columns. The result will only include records which match all the columns.
  • For each column, you can enter any number of values separated by commas. The result will include records which match any of the values for that column.