• Documentation >
• Apps >
• IT and Development >
• Grist

Grist

With Grist modules in Ibexa Connect, you can:

• update, retrieve, and list organizations, list organization users, update organization access, and list workspaces within organizations

• create, update, retrieve, list, and delete workspaces, list workspace users, and update workspace access

• create, retrieve, move, and delete documents, retrieve a document as an excel file and SQLite file, update document access and document metadata, and list document users

• add and update records to a table, list records from a table, list table columns, and delete table rows

• watch documents and workspaces

To get started with Grist, create an account at getgrist.com

Connect Grist to Ibexa Connect

To connect Grist app, you need to obtain the Domain and API Key values from your Grist account and insert them in the Grist module scenario.

1. Log in to your Grist account.

2. Click Profile Settings and copy the API Key to a safe place.

   

3. Click Create new team site. Skip this step if you already have a second site.

   

4. Enter the Team name and Team subdomain. Click Create site.

   

5. Click Go to your site. Copy the subdomain from the website. For example, team domain <Team>.getgrist.com.

   

6. Log in to your Ibexa Connect account, insert a Grist module scenario and click the Add button next to the Connection field.

   

7. In the Connection name field, enter a name for the connection.

8. In the Domain and API Key fields, enter the details copied in step 2 and click Save.

You have successfully established the connection. You can now begin editing your scenario and adding more Grist modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Organizations

You can update, retrieve, list organizations, and organization users, update organization access, and list workspaces within organizations using the following modules.

List Organizations

Returns a list of personal spaces. Team sites and personal spaces are called 'orgs' in the API.

Limit	Set the maximum number of organizations Ibexa Connect will return during one execution cycle. The default value is 10.

Get an Organization

Returns detailed information about personal space.

Organization ID	Select or map the Organization ID whose details you want to retrieve.

Update an Organization

Updates information about an existing organization.

Organization ID	Select or map the Organization ID whose details you want to update.
Name	Enter an updated name for the organization.

List Organization Users

Returns a list of users with access to org.

Organization ID	Select or map the Organization ID whose users you want to list.
Limit	Set the maximum number of users Ibexa Connect will return during one execution cycle. The default value is 10.

Update Organization Access

Changes who has access to the organization.

Org ID	Select or map the Organization ID whose access you want to update.

For field descriptions, see the Grist Organizations API reference.

List Workspaces within Organization

Returns a list of workspaces and documents within an organization.

Organization ID	Select or map the Organization ID whose workspaces you want to list.

Workspaces

You can create, update, retrieve, list, and delete workspaces, list workspace users, and update workspace access using the following modules.

Create a Workspace

Creates an empty workspace.

Note

Workspaces are available only on team plans.

Organization ID	Select or map the Organization ID where you want to create the workspace.
Name	Enter a name for the workspace.

Get a Workspace

Returns detailed information about a workspace.

Workspace ID	Select or map the Workspace ID whose details you want to retrieve.

Update a Workspace

Updates information about the existing workspace.

Workspace ID	Select or map the Workspace ID whose details you want to update.
New Workspace Name	Enter a new name for the workspace.

Delete a Workspace

Deletes a workspace. Available on a Team Plan.

Workspace ID	Select or map the Workspace ID you want to delete.

List Workspace Users

Returns a list of users that have access to the workspace.

Workspace ID	Select or map the Workspace ID whose users you want to list.

Update a Workspace Access

Changes who has access to the workspace.

Workspace ID	Select or map the Workspace ID whose access you want to update.

For field descriptions, see the Grist Workspaces API reference.

List Workspaces

Returns a list of workspaces available in the current domain.

Limit	Set the maximum number of workspaces Ibexa Connect will return during one execution cycle. The default value is 10.

Documents

You can create, retrieve, move, and delete documents, retrieve a document as an excel file and SQLite file, update document access and document metadata, and list document users using the following modules.

Create a Document

Creates an empty document.

Workspace ID	Select or map the Workspace ID whose document you want to create.

For field descriptions, see the Grist Documents API reference.

Delete a Document

Deletes a document.

Document ID	Select or map the Document ID you want to delete.

Update a Document Metadata

Updates an existing document metadata but not its contents.

Document ID	Select or map the Document ID whose metadata you want to update.

For field descriptions, see the Grist Documents API reference.

Get a Document

Returns detailed information about a document.

Document ID	Select or map the Document ID whose details you want to retrieve.

Move a Document

Move a document to another workspace in the same organization. Available on a Team Plan.

Document ID	Select or map the Document ID you want to move.
Workspace	Select or map the Workspace ID whose document you want to move.

Get a Document as an Excel file

Returns the content of the document as an Excel file.

Document ID	Select or map the Document ID you want to retrieve as an Excel file.

Update a Document Access

Changes who has access to a document.

Document ID	Select or map the Document ID whose access you want to update.

For field descriptions, see the Grist Documents API reference.

List a Document Users

Returns a list of users with access to a document.

Document ID	Select or map the Document ID whose users you want to list.
Limit	Set the maximum number of users Ibexa Connect will return during one execution cycle. The default value is 10.

Get a Document as SQLite File

Returns the content of a document, as an SQLite file.

Document ID	Select or map the Document ID whose document you want to retrieve as an SQLite file.

Get a Document Table as CSV File

Returns the content of a document's table as a CSV file.

Document ID	Select or map the Document ID whose table you want to retrieve as a CSV file.
Table Name	Enter the name of the table.

Tables

You can add records to a table, update them, list records from a table, list table columns, and delete table rows using the following modules.

List Records from a Table

Returns a list of records.

Document ID	Select or map the Document ID whose records you want to list.

For field descriptions, see the Grist Tables API reference.

Add Records to a Table

Add new records to a specified table.

Document ID	Select or map the Document ID to whose table you want to add new records.

For field descriptions, see the Grist Tables API reference.

Update records of a Table.

Modifies records of a table.

Document ID	Select or map the Document ID whose records of a table you want to update.

For field descriptions, see the Grist Tables API reference.

List Table Columns

Returns a list of the table's columns.

Document ID	Select or map the Document ID whose table columns you want to list.
Table Name	Enter the table name whose columns you want to list.
Limit	Set the maximum number of table columns Ibexa Connect will return during one execution cycle. The default value is 10.

Delete Table Rows

Removes rows from a table.

Document ID	Select or map the Document ID whose table rows you want to delete.
Table Name	Enter the table name whose rows you want to delete.
Row IDs	Enter an array of Row IDs to delete.

Triggers

You can watch documents and workspaces using the following modules.

Watch Documents

Triggers when a new document is created or an existing document is updated.

Event Type	Select an event type: Created Updated
Limit	Set the maximum number of documents Ibexa Connect will return during one execution cycle. The default value is 2.

Watch Workspaces

Triggers when a workspace is created or an existing document is updated.

Event Type	Select an event type: Created Updated
Limit	Set the maximum number of workspaces Ibexa Connect will return during one execution cycle. The default value is 2.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the Grist API documentation.

URL	Enter a path relative to https://integromatteam.getgrist.com/api. For example: /orgs.
Method	GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of use - List Organization Users

The following API call returns all organization users from your account.

URL: /orgs/{orgId}/access

Method: GET

The search matches can be found in the module's Output under Bundle > Body > users.

In our example 3 users were returned: