NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Grist

grist

Grist is a relational spreadsheet platform that combines the flexibility of a spreadsheet with the robustness of a database, allowing users to create custom applications tailored to their data needs.

ProductivitySpreadsheetsDatabasesWeb del proveedor
Acciones
32
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (32)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add RecordsGRIST_ADD_RECORDSAcción

Tool to add records to a specified table in a Grist document. Use after confirming doc and table IDs.

Parámetros de entrada

  • docIdstringObligatorio

    Document ID (UUID).

  • noparseboolean

    If true, do not parse strings according to column type.

  • recordsobject[]Obligatorio

    List of records to add to the table.

  • tableIdstringObligatorio

    Table identifier: normalized table name or numeric row ID in _grist_Tables.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create DocumentGRIST_CREATE_DOCUMENTAcción

Tool to create a document in a workspace. Use when you need to add a new document programmatically after selecting a workspace.

Parámetros de entrada

  • namestring

    Optional human-readable name for the new document.

  • isPinnedboolean

    Whether the new document should be pinned in the workspace.

  • workspaceIdintegerObligatorio

    Numeric ID of the workspace in which to create the document.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create SCIM UserGRIST_CREATE_SCIM_USERAcción

Tool to create a new SCIM user. Use when provisioning new user accounts via SCIM. Run after gathering all required user details.

Parámetros de entrada

  • nameobjectObligatorio

    SCIM name object with givenName and familyName

  • emailsobject[]Obligatorio

    At least one email object for the user

  • localestring

    Locale for formatting, e.g., 'en_US'

  • photosobject[]

    List containing a single photo object for the user

  • schemasstring[]Obligatorio

    List of SCIM schema URNs; must include 'urn:ietf:params:scim:schemas:core:2.0:User'

  • userNamestringObligatorio

    Unique username for the SCIM user

  • displayNamestring

    Display name of the user

  • preferredLanguagestring

    Preferred language tag, e.g., 'en-US'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create TableGRIST_CREATE_TABLEAcción

Tool to create tables in a document. Use after confirming the document ID. Creates one or more tables with specified columns in the given document.

Parámetros de entrada

  • docIdstringObligatorio

    UUID of the Grist document in which to create tables.

  • tablesobject[]Obligatorio

    List of tables to add to the document.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Document WebhookGRIST_CREATE_WEBHOOKAcción

Tool to create a new webhook for a specified document. Use when you need to register webhook endpoints for document events in Grist. Run after confirming document ID.

Parámetros de entrada

  • docIdstringObligatorio

    Document ID (UUID) in which to create the webhook.

  • webhooksobject[]Obligatorio

    Array of webhook settings to create.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete AttachmentGRIST_DELETE_ATTACHMENTAcción

Tool to delete a specified attachment from a Grist document. Use when you need to remove a file by providing its document and attachment IDs.

Parámetros de entrada

  • doc_idstringObligatorio

    The Grist document identifier in which the attachment resides

  • expiredOnlyboolean

    If true, remove only attachments that have expired (unused for a configured period)

  • attachment_idintegerObligatorio

    The identifier of the attachment to delete (used for response only; actual deletion uses removeUnused API)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ColumnGRIST_DELETE_COLUMNAcción

Tool to delete a column from a Grist document table. Use after confirming document, table, and column IDs.

Parámetros de entrada

  • col_idstringObligatorio

    Column ID without the leading '$', as shown in column settings

  • doc_idstringObligatorio

    UUID of the Grist document containing the table

  • table_idstringObligatorio

    Normalized table name or numeric row ID from _grist_Tables

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Grist Table RecordsGRIST_DELETE_RECORDSAcción

Tool to delete records from a specified Grist table. Use when you need to remove specific rows by their IDs. Use after confirming the row IDs exist.

Parámetros de entrada

  • doc_idstringObligatorio

    UUID of the Grist document containing the table

  • row_idsinteger[]Obligatorio

    List of integer row IDs to delete; must contain at least one ID

  • table_idstringObligatorio

    Normalized table name or numeric ID of the table

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete SCIM UserGRIST_DELETE_SCIM_USERAcción

Tool to delete a specified user via SCIM. Use after confirming the user's SCIM user ID exists.

Parámetros de entrada

  • user_idintegerObligatorio

    The SCIM user ID to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete WebhookGRIST_DELETE_WEBHOOKAcción

Tool to delete a webhook from a Grist document. Use when you need to remove a specific webhook after confirming its ID.

Parámetros de entrada

  • doc_idstringObligatorio

    Identifier of the Grist document to remove the webhook from

  • webhook_idstringObligatorio

    Identifier of the webhook to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Download All Attachments ArchiveGRIST_DOWNLOAD_ALL_ATTACHMENTS_ARCHIVEAcción

Tool to download all attachments from a Grist document as a .zip or .tar archive. Use after ensuring attachments exist in the specified document.

Parámetros de entrada

  • doc_idstringObligatorio

    Document ID (UUID) of the Grist document to download attachments from.

  • formatstringenum

    Archive format to return; one of 'zip' or 'tar'. If omitted, server default is used.

    ziptar

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Download AttachmentGRIST_DOWNLOAD_ATTACHMENTAcción

Tool to download the binary data of an attachment. Use when you have the document ID and attachment ID and need the raw file content.

Parámetros de entrada

  • docIdstringObligatorio

    Document ID (UUID) to download the attachment from

  • attachmentIdintegerObligatorio

    ID of the attachment to download

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Download Grist Attachment ContentGRIST_DOWNLOAD_ATTACHMENT_CONTENTAcción

Tool to download the raw bytes of an attachment. Use when you need to retrieve the binary data of a specific Grist document attachment after confirming the document and attachment IDs.

Parámetros de entrada

  • docIdstringObligatorio

    Document ID (UUID) to fetch the attachment from

  • attachmentIdintegerObligatorio

    ID of the attachment to download

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Fetch Column MetadataGRIST_FETCH_COLUMN_METADATAAcción

Tool to fetch metadata for a specific column in a Grist document table. Use when you need to inspect column properties before data operations.

Parámetros de entrada

  • col_idstringObligatorio

    The column ID within the table to retrieve metadata for.

  • doc_idstringObligatorio

    The unique identifier (UUID) of the document.

  • table_idstringObligatorio

    The table ID or normalized table name within the document.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Fetch Document MetadataGRIST_FETCH_DOCUMENT_METADATAAcción

Tool to fetch metadata for a specified Grist document. Use after obtaining the document ID.

Parámetros de entrada

  • doc_idstringObligatorio

    Document identifier (UUID)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Fetch Table MetadataGRIST_FETCH_TABLE_METADATAAcción

Tool to retrieve metadata for a specified table in a Grist document. Use when you need to inspect table schema details before data operations.

Parámetros de entrada

  • doc_idstringObligatorio

    The unique identifier (UUID) of the document.

  • headerstringenum

    Header format: 'colId' for column IDs or 'label' for column labels.

    colIdlabel
  • table_idstringObligatorio

    The table ID or normalized table name within the document.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Org AccessGRIST_GET_ORG_ACCESSAcción

Tool to fetch org access details. Use when you need to retrieve numeric user IDs for actions like SCIM user deletion when SCIM API is disabled.

Parámetros de entrada

  • org_idinteger

    Organization identifier: numeric ID, subdomain string, or 'current' for the current org

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get UsersGRIST_GET_USERSAcción

Tool to retrieve a list of users via SCIM v2. Use when you need to page through and filter enterprise users in Grist.

Parámetros de entrada

  • countinteger

    Number of users to return in this page.

  • filterstring

    SCIM filter string to narrow down the results, e.g. 'userName eq "alice"'.

  • startIndexinteger

    1-based index at which to start pagination.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List AttachmentsGRIST_LIST_ATTACHMENTSAcción

Tool to list all attachments in a Grist document. Use after confirming the document ID to retrieve attachment metadata.

Parámetros de entrada

  • sortstring

    Comma-separated column list for sorting; prefix with '-' for descending; supports options after ':' (choiceOrder, naturalSort, emptyFirst), e.g. 'name,-size:choiceOrder'

  • docIdstringObligatorio

    UUID of the Grist document to list attachments from

  • limitinteger

    Maximum number of attachments to return; 0 means no limit

  • X-Sortstring

    Sort override in header, same format as 'sort' query parameter

  • filterstring

    URL-encoded JSON mapping column names to arrays of allowed values for filtering attachments, e.g. '{"pet":["cat","dog"]}'

  • X-Limitinteger

    Limit override in header, same format as 'limit' query parameter

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ColumnsGRIST_LIST_COLUMNSAcción

Tool to list all columns in a specified Grist table. Use after selecting the document and table to inspect column metadata.

Parámetros de entrada

  • doc_idstringObligatorio

    The unique identifier (UUID) of the document.

  • hiddenboolean

    Whether to include hidden columns (e.g., 'manualSort').

  • table_idstringObligatorio

    The table ID or normalized table name within the document.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List OrganizationsGRIST_LIST_ORGANIZATIONSAcción

Tool to list all organizations accessible to the authenticated user. Use when you need to select a Grist organization for subsequent operations.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List RecordsGRIST_LIST_RECORDSAcción

Tool to retrieve records from a specified table within a Grist document. Use when you need to fetch rows by applying optional filters, sorting, limits, or hidden columns. Example: list records where pet is 'cat' sorted by '-age'.

Parámetros de entrada

  • sortstring

    Comma-separated columns to sort by; prefix with '-' for descending. Supports options via ':choiceOrder', 'naturalSort', 'emptyFirst'.

  • docIdstringObligatorio

    Document ID (UUID) of the Grist document.

  • limitinteger

    Maximum number of rows to return; 0 means no limit.

  • filterstring

    URL-encoded JSON mapping column names to allowed values arrays. Example: '{"pet":["cat","dog"]}'.

  • hiddenboolean

    If true, include hidden columns (e.g., manualSort).

  • tableIdstringObligatorio

    Table identifier (normalized name) or numeric _grist_Tables row ID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List TablesGRIST_LIST_TABLESAcción

Tool to list all tables within a specified document. Use after obtaining the document ID to retrieve its tables.

Parámetros de entrada

  • docIdstringObligatorio

    Document ID (UUID) of the Grist document to list tables from.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List WebhooksGRIST_LIST_WEBHOOKSAcción

Tool to list webhooks configured for a document. Use when you need to retrieve all webhooks for a document after obtaining its ID.

Parámetros de entrada

  • doc_idstringObligatorio

    The unique identifier (UUID) of the document to list webhooks for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List WorkspacesGRIST_LIST_WORKSPACESAcción

Tool to list all workspaces and documents accessible to the authenticated user on the current site. Use when you need to select a workspace or document for subsequent operations.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Run SQL QueryGRIST_RUN_SQL_QUERYAcción

Tool to execute a read-only SQL SELECT query on a Grist document. Use after confirming the document ID and preparing a valid SQL SELECT statement.

Parámetros de entrada

  • sqlstringObligatorio

    Single read-only SELECT statement without trailing semicolon; WITH clauses allowed.

  • argsarray

    Positional parameters for the SQL statement.

  • docIdstringObligatorio

    UUID of the Grist document to query.

  • timeoutinteger

    Maximum execution time in milliseconds (default 1000; may only be reduced).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Column MetadataGRIST_UPDATE_COLUMN_METADATAAcción

Tool to update metadata for one or more columns in a Grist document table. Use after confirming document and table IDs. Example: change label or type of columns.

Parámetros de entrada

  • docIdstringObligatorio

    UUID of the Grist document containing the table

  • columnsobject[]Obligatorio

    List of column metadata updates to apply

  • tableIdstringObligatorio

    Normalized table name or numeric table ID from _grist_Tables

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Document MetadataGRIST_UPDATE_DOCUMENT_METADATAAcción

Tool to update metadata for a specified Grist document. Use when you need to rename or pin/unpin a document after obtaining its ID.

Parámetros de entrada

  • namestring

    New document name

  • doc_idstringObligatorio

    UUID of the Grist document

  • isPinnedboolean

    Whether the document is pinned

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update RecordsGRIST_UPDATE_RECORDSAcción

Tool to update records in a specified table within a document. Use after fetching record IDs.

Parámetros de entrada

  • docIdstringObligatorio

    Document ID (UUID) of the Grist document.

  • noparseboolean

    If true, string values will not be auto-parsed to column types.

  • recordsobject[]Obligatorio

    List of record-update objects; each must specify id and fields.

  • tableIdstringObligatorio

    Table identifier (normalized name) or numeric _grist_Tables row ID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Table MetadataGRIST_UPDATE_TABLE_METADATAAcción

Tool to update metadata for a specified table. Use after confirming document and table IDs to modify properties such as onDemand or visibility.

Parámetros de entrada

  • docIdstringObligatorio

    Document ID (UUID) of the Grist document containing the table.

  • fieldsobjectObligatorio

    Mapping of metadata fields to update for the table. Keys must be valid Grist table metadata properties, e.g., 'onDemand'.

  • tableIdstringObligatorio

    Table identifier (normalized name) or numeric ID of the table to update.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update WebhookGRIST_UPDATE_WEBHOOKAcción

Tool to update an existing webhook for a specified document. Use when you need to modify webhook settings after confirming document and webhook IDs.

Parámetros de entrada

  • urlstringuri

    Destination URL to receive webhook calls

  • memostring

    Longer description for the webhook

  • namestring

    Short descriptive name for the webhook

  • doc_idstringObligatorio

    UUID of the Grist document containing the webhook

  • enabledboolean

    Whether the webhook is active

  • tableIdstring

    Table ID to monitor for changes

  • eventTypesstring[]

    List of events that trigger the webhook (e.g., ['add','update'])

  • webhook_idstringObligatorio

    Identifier of the webhook to update

  • isReadyColumnstring

    Column ID used to gate visibility or triggering

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Upload AttachmentGRIST_UPLOAD_ATTACHMENTAcción

Tool to upload one or more attachments to a Grist document. Use when you need to add files to a document after preparing file data.

Parámetros de entrada

  • docIdstringObligatorio

    UUID of the Grist document to attach files to

  • filesobject[]Obligatorio

    List of files to upload as attachments

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not