Coda

1. Overview

Coda is an all-in-one collaborative documentation tool that combines the functionality of documents, spreadsheets, databases, and applications into a flexible canvas, enabling teams to create dynamic, interconnected documents to manage projects, knowledge bases, and more.

Through GoInsight's Coda node, you can seamlessly integrate Coda's powerful capabilities into your automated workflows, achieving programmatic management of core resources such as documents, tables, and data rows. This makes advanced use cases such as automated report creation, data synchronization, and triggering actions within Coda possible, including:

  • Document Management: Automatically create or delete Coda documents.
  • Data Operations: Create, read, update, and delete data rows in specified tables or views.
  • Structure Queries: Retrieve detailed information about tables, views, columns, formulas, and controls within documents.
  • Interactive Triggers: Programmatically "push" buttons in Coda documents to trigger preset automations or actions.

2. Prerequisites

Before using this node, you need to have a valid Coda account. You may need appropriate permissions to generate an API token for authentication in your Coda account settings.

3. Credentials

For detailed guidance on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

Summary

This Coda node primarily operates around Documents (Doc), Tables, Rows, Views, and their related elements, allowing you to comprehensively manage content and data in Coda.

Resource Operation Description
Document Create a Doc Create a new Coda document.
Document Delete a Doc Delete a specified Coda document.
Document Get All Doc Get all accessible Coda documents.
Table List Tables List all tables in the specified Coda document.
Table Get a Table Get details of a specific table in a Coda document.
Column Get All Columns Get all columns of a specified table in a Coda document.
Column Get a Column Get details of a specific column in a Coda table.
Row Create a Row Create a new row of data in a Coda table.
Row Delete a Row Delete a specified row from a Coda table.
Row Get All Rows Get all rows in a Coda table.
Row Get a Row Get information about a specified row from a Coda table.
View Get Many Views Get all views in a Coda document.
View Get a View Get a specific view from a Coda document.
View Column Get All View Columns Get all columns in a Coda view.
View Row Delete a View Row Delete a specified row from a Coda view.
View Row Get a View Row Get information about a specified row from a Coda view.
View Row Update a View Row Update a specified row in a Coda view.
Control Get Many Controls Get all controls in a Coda document.
Control Get a Control Get a specific control from a Coda document.
Formula Get Many Formulas Get all formulas in a Coda document.
Formula Get a Formula Get a specific formula from a Coda document.
Button Push a Button Push a button in a Coda table row.
Button Push a View Button Push a button in a Coda view row.

Operation Details

Create a Doc

Create a new Coda document.

Input Parameters:

  • Name: Name of the new Coda document.

Output:

  • Doc (object): Information about the newly created Coda document.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Create a Row

Create a new row of data in a Coda table.

Input Parameters:

  • DocId: ID of the Coda document.
  • TableId: ID or name of the Coda table.
  • Values: CSV format string for creating multiple rows, e.g., "ccc,333,333\nddd,444,444".

Output:

  • Success (bool): Whether the data addition operation was successful.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Delete a Doc

Delete a specified Coda document.

Input Parameters:

  • DocId: ID of the Coda document to delete.

Output:

  • IsDeleted (bool): Whether the document was successfully deleted.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Delete a Row

Delete a specified row from a Coda table.

Input Parameters:

  • DocId: ID of the Coda document.
  • TableId: ID or name of the Coda table.
  • RowId: ID or name of the Coda row.

Output:

  • IsDeleted (bool): Whether the row was successfully deleted.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Delete a View Row

Delete a specified row from a Coda view.

Input Parameters:

  • DocId: ID of the Coda document.
  • ViewId: ID or name of the Coda view.
  • RowId: ID or name of the Coda row.

Output:

  • IsDeleted (bool): Whether the row was successfully deleted from the view.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get All Columns

Get all columns of a specified table in a Coda document.

Input Parameters:

  • DocId: ID of the Coda document.
  • TableId: ID or name of the table.

Output:

  • Columns (object-array): List of columns in the specified table.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get All Doc

Get all accessible Coda documents.

Output:

  • Docs (object-array): List of accessible Coda documents.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get All Rows

Get all rows in a Coda table.

Input Parameters:

  • DocId: ID of the Coda document.
  • TableId: ID or name of the Coda table.

Output:

  • Rows (object-array): List of rows in the Coda table.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get All View Columns

Get all columns in a Coda view.

Input Parameters:

  • DocId: ID of the Coda document.
  • ViewId: ID or name of the Coda view.

Output:

  • Columns (object-array): List of columns in the Coda view.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get Many Controls

Get all controls in a Coda document.

Input Parameters:

  • DocId: ID of the Coda document.

Output:

  • Controls (object-array): List of controls in the Coda document.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get Many Formulas

Get all formulas in a Coda document.

Input Parameters:

  • DocId: ID of the Coda document.

Output:

  • Formulas (object-array): List of formulas in the Coda document.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get Many Views

Get all views in a Coda document.

Input Parameters:

  • DocId: ID of the Coda document.

Output:

  • Views (object-array): List of views in the Coda document.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get a Column

Get details of a specific column in a Coda table.

Input Parameters:

  • DocId: ID of the Coda document.
  • TableId: ID or name of the table.
  • ColumnId: ID or name of the column.

Output:

  • Column (object): Details of the specified column.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get a Control

Get a specific control from a Coda document.

Input Parameters:

  • DocId: ID of the Coda document.
  • ControlId: ID or name of the Coda control.

Output:

  • Control (object): The specified control in the Coda document.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get a Formula

Get a specific formula from a Coda document.

Input Parameters:

  • DocId: ID of the Coda document.
  • FormulaId: ID or name of the Coda formula.

Output:

  • Formula (object): The specified formula in the Coda document.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get a Row

Get information about a specified row from a Coda table.

Input Parameters:

  • DocId: ID of the Coda document.
  • TableId: ID or name of the Coda table.
  • RowId: ID or name of the Coda row.

Output:

  • Row (object): The specified row in the Coda table.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get a Table

Get details of a specific table in a Coda document.

Input Parameters:

  • DocId: ID of the Coda document.
  • TableId: ID or name of the table.

Output:

  • Table (object): Details of the specified table.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get a View

Get a specific view from a Coda document.

Input Parameters:

  • DocId: ID of the Coda document.
  • ViewId: ID or name of the Coda view.

Output:

  • View (object): The specified view in the Coda document.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Get a View Row

Get information about a specified row from a Coda view.

Input Parameters:

  • DocId: ID of the Coda document.
  • ViewId: ID or name of the Coda view.
  • RowId: ID or name of the Coda row.

Output:

  • Row (object): The specified row in the Coda view.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

List Tables

List all tables in the specified Coda document.

Input Parameters:

  • DocId: ID of the Coda document.

Output:

  • Tables (object-array): List of tables in the Coda document.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Push a Button

Push a button in a Coda table row.

Input Parameters:

  • DocId: ID of the Coda document.
  • TableId: ID or name of the Coda table.
  • RowId: ID or name of the Coda row.
  • ButtonColumnId: ID or name of the Coda button column.

Output:

  • Success (bool): Whether the button was successfully pushed.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Push a View Button

Push a button in a Coda view row.

Input Parameters:

  • DocId: ID of the Coda document.
  • ViewId: ID or name of the Coda view.
  • RowId: ID or name of the Coda row.
  • ButtonColumnId: ID or name of the Coda button column.

Output:

  • Success (bool): Whether the button was successfully pushed in the view.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

Update a View Row

Update a specified row in a Coda view.

Input Parameters:

  • DocId: ID of the Coda document.
  • ViewId: ID or name of the Coda view.
  • RowId: ID or name of the Coda row.
  • Values: Key-value pairs for updating, e.g., "Name: John\nAge: 18\nGender: Male" (also supports Chinese colons).

Output:

  • UpdatedRow (object): The updated row in the Coda view.
  • StatusCode (number): Operation status code.
  • ErrorMessage (string): Error message if the operation fails.

5. Example Usage

This section will guide you through creating a simple workflow to add a new row of data to a specified table in Coda. For example, we can add a new task to a "Task List" table.

Workflow Overview

A basic workflow contains three nodes: Start -> Coda: Create a Row -> Answer.

Step-by-Step Guide

  1. Add Tool Node:
    • In the workflow canvas, click the "+" button to add a new node.
    • Select the "Tools" tab in the pop-up panel.
    • Find and select Coda in the tools list.
    • In the Coda supported operations list, click to select Create a Row, which will add a corresponding node to the canvas.
  2. Configure Node:
    • Click the newly added Create a Row node, and the configuration panel for this node will expand on the right side.
    • Credentials Configuration: At the top of the panel, find the credentials field. Click the dropdown menu and select your configured Coda credentials.
    • Parameter Filling: Fill in the input parameters for this operation in detail.
    • DocId: Enter your Coda document ID. You can find it in the browser address bar, usually the string after coda.io/d/. For example, abcdef1234.
    • TableId: Enter the ID or name of the table you want to operate on. For example, grid-xyz789 or Task List.
    • Values: Enter the data to add in CSV string format. Values for each column are separated by commas. Assuming your table has three columns: "Task Name", "Assignee", and "Due Date", you can enter: "Complete Quarterly Report","John Smith","2024-12-31".
  3. Run and Verify:
    • When all required parameters are filled in correctly, the error message in the upper right corner of the workflow canvas will disappear.
    • Click the "Test Run" button in the upper right corner of the canvas to execute the workflow.
    • After successful execution, you can click the log icon in the upper right corner to view the detailed input and output of the node. The Success field in the output should be true. Meanwhile, you can open your Coda document and will find that this new row of data has been added to the table.

Final Workflow Display

After completing the above steps, your entire workflow is configured. Click "Test Run", and a new row of task data will be successfully added to your specified Coda table.

6. FAQs

Q: How do I find my DocId, TableId, or ViewId?

A: You can find these IDs from the URL of your Coda document:

  • DocId: When you open a Coda document, the URL format is usually https://coda.io/d/Document-Name_d[DocId]. The string after d is the document ID.
  • TableId/ViewId: Click on a table or view in the document, and the URL will change to https://coda.io/d/Document-Name_d[DocId]/[TableId]. The last part of the URL is the table or view ID, usually starting with grid- or view-.

Q: I encountered an error when using "Create a Row", saying the format is incorrect. How should I check?

A: Please ensure that the Values field format strictly follows CSV specifications.

  • Column Count Match: The number of comma-separated values you provide must exactly match the number of columns in the target table.
  • Special Characters: If your values contain commas or newlines, enclose the entire value in double quotes.
  • Multiple Row Insertion: To insert multiple rows at once, use the newline character \n to separate data for each row.

Q: I received a 401 Unauthorized or 403 Forbidden error. Why is this?

A: This is usually related to your API credentials. Please check the following:

  • Is the API token correct: Confirm that the Coda API token configured in GoInsight is valid and has not been revoked.
  • Token Permissions: Ensure that the API token you generated has sufficient permissions to perform the operation you want. For example, a read-only token cannot be used to create or delete rows.
  • Document Access Rights: Confirm that the account that generated the API token has access to the Coda document specified in the node.

7. Official Documentation

For a deeper understanding of all the features and details of the Coda API, please refer to the official documentation:

Coda Official API Documentation

4. Supported Operations

Summary

This node allows you to manage various Coda resources, including documents, tables, rows, columns, views, controls, and formulas.

Resource Operation Description
Document Create a Doc Create a new Coda document.
Document Delete a Doc Delete a specified Coda document.
Document Get All Doc Get all accessible Coda documents.
Table Get a Table Get details of a specific table in a Coda document.
Table List Tables List all tables in a specified Coda document.
Column Get All Columns Get all columns from a specified table in a Coda document.
Column Get a Column Get details of a specific column in a Coda table.
Row Create a Row Create a new row in a Coda table.
Row Delete a Row Delete a specific row from a Coda table.
Row Get All Rows Get all rows from a Coda table.
Row Get a Row Get a specific row from a Coda table.
Row Push a Button Push a button in a Coda row.
View Get Many Views Get all views from a Coda document.
View Get a View Get a specific view from a Coda document.
View Column Get All View Columns Get all columns from a Coda view.
View Row Delete a View Row Delete a specific row from a Coda view.
View Row Get a View Row Get a specific row from a Coda view.
View Row Push a View Button Push a button in a Coda view row.
View Row Update a View Row Update a specific row in a Coda view.
Control Get Many Controls Get all controls from a Coda document.
Control Get a Control Get a specific control from a Coda document.
Formula Get Many Formulas Get all formulas from a Coda document.
Formula Get a Formula Get a specific formula from a Coda document.

Operation Details

Create a Doc

Create a new Coda document.

Input Parameters:

  • Name: Title of the new document (1-255 characters). Defaults to 'Untitled' if not provided. Examples: 'Q1 2026 Budget Planning', 'Product Roadmap'.

Options:

  • SourceDoc: Optional: Document ID to copy from. Creates new document as a copy of this source document. Get sourceDoc ID from another document's properties or Get_All_Doc action.
  • Timezone: Optional: Timezone for the new document. Common values: 'America/New_York', 'Europe/London', 'Asia/Shanghai', 'Asia/Tokyo'. If not specified, defaults to account timezone.
  • FolderId: Optional: Folder ID where to create the document. Defaults to 'My docs' folder. Get folderId from folder URL query parameter (?folderId=...) when browsing docs.

Output:

  • Doc (object): The newly created Coda document object containing: id (string: unique document ID), name (string: document name), href (string: web URL to open in browser), createdTime (ISO 8601 timestamp), updatedTime (ISO 8601 timestamp), owner (object with id and email), role (string: user's role like 'owner').
  • StatusCode (number): HTTP status code: 201 (created successfully), 400 (bad request), 401 (unauthorized), 403 (forbidden), 429 (rate limited), 500+ (server error).
  • ErrorMessage (string): Error details if StatusCode is not 201. Includes ErrorType field for classification (INVALID_TOKEN, PERMISSION_DENIED, RATE_LIMITED, etc.).

Delete a Doc

Delete a specified Coda document.

Input Parameters:

  • DocId: ID of the Coda document to delete. Get it from: 1. Document URL: https://coda.io/d/{DocId}/... 2. Get_All_Doc action result 3. Using document properties/details. ⚠️ WARNING: This action permanently deletes the document and cannot be undone.

Output:

  • IsDeleted (bool): Boolean indicating if deletion was successful. True means StatusCode is 202/204 and document will be deleted. False means deletion failed - check StatusCode and ErrorMessage for details.
  • StatusCode (number): HTTP status code: 202 (Accepted, async delete), 204 (deleted), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 500+ (server error).
  • ErrorMessage (string): Error details if StatusCode is not 202/204. Includes ErrorType field for classification (INVALID_TOKEN, PERMISSION_DENIED, NOT_FOUND, etc.).

Get All Doc

Get all accessible Coda documents.

Options:

  • IsOwner: Optional: If true, return only docs owned by the authenticated user.
  • IsPublished: Optional: If true, return only published docs. Default: return all docs.
  • Query: Optional: Search term to filter docs by name or content. Supports substring matching.
  • SourceDoc: Optional: Return only docs that were copied from the specified source document ID.
  • IsStarred: Optional: If true, return only starred docs. If false, return only non-starred docs.
  • InGallery: Optional: If true, return only docs visible in the Coda gallery.
  • WorkspaceId: Optional: Return only docs belonging to the specified workspace ID.
  • FolderId: Optional: Return only docs belonging to the specified folder ID.
  • Limit: Optional: Maximum number of results to return in this query. Default: 25, Maximum: varies by endpoint.
  • PageToken: Optional: Opaque token used to fetch the next page of results. Returned as 'NextPageToken' in previous response. Pass this to get the next page.

Output:

  • Docs (object-array): Array of Coda document objects. Each doc contains ID, name, type, owner info, and timestamps.
  • NextPageToken (string): Opaque token for fetching the next page of results. If empty, there are no more results. Pass this as PageToken parameter to get the next page.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Get a Table

Get details of a specific table in a Coda document.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Doc or document URL: https://coda.io/d/{DocId}/...
  • TableId: Coda table ID or name (ID recommended). Get from List_Tables or table URL. If using name, ensure it's URI-encoded.

Options:

  • UseUpdatedTableLayouts: Optional: If true, returns 'detail' and 'form' for the layout field of detail and form layouts respectively (instead of 'masterDetail' for both). Default false.

Output:

  • Table (object): Table object containing table metadata including id, name, href, createdTime, updatedTime, layout (masterDetail or detail/form depending on useUpdatedTableLayouts), displayOptions, and sortOptions.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 500+ (server error).
  • ErrorMessage (string): Error details if StatusCode is not 200. StatusCode identifies error type, ErrorMessage provides details.

List Tables

List all tables in a specified Coda document.

Input Parameters:

  • DocId: ID of the Coda document. Get it from: 1. Document URL: https://coda.io/d/{DocId}/... 2. Get_All_Doc action result 3. Document properties/details. Example: abcDef9H.

Options:

  • limit: Maximum number of results to return (>= 1). Default: 25. Higher values reduce API calls but increase memory usage.
  • PageToken: Optional: Opaque token for cursor-based pagination. Obtained from NextPageToken in previous response. Leave empty for first page. Important: When you receive NextPageToken=null from previous call, do NOT pass any PageToken - pagination is complete. Per official API docs, when pageToken is provided, other parameters are ignored.
  • SortBy: Optional: Sort order for tables. Supported values: 'name' (sort by table name). If not specified, uses default API order.
  • TableTypes: Optional: Filter tables by type. Comma-separated values: 'table' (regular tables), 'view' (views). If omitted, returns both types. Example: 'table,view' or just 'table'.

Output:

  • Tables (object-array): Array of table/view objects. Each contains: id (string), name (string), href (string URL), createdTime (ISO 8601), updatedTime (ISO 8601), tableType (string: 'table' or 'view').
  • NextPageToken (string): Opaque token for fetching the next page of results. If null or empty string, there are no more pages available and pagination is complete. To fetch next page: pass this token as PageToken parameter in the next call. Important: When NextPageToken is null, do NOT make another call - you have reached the end of results.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 500+ (server error).
  • ErrorMessage (string): Error details if StatusCode is not 200. Includes error type (ErrorType field) for troubleshooting.

Get All Columns

Get all columns from a specified table in a Coda document.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • TableId: Coda table ID or name (ID recommended). Get from List_Tables or table URL. Names are discouraged as they are fragile and prone to being changed by users. If you're using a name, ensure it is URI-encoded.

Options:

  • Limit: Optional: Maximum number of results to return in this query. Default: 25, Maximum: 100.
  • PageToken: Optional: Opaque token used to fetch the next page of results. Returned as 'NextPageToken' in previous response. Pass this to get the next page.
  • VisibleOnly: Optional: If true, return only visible columns for the table. This parameter only applies to base tables, not views. Default: false (return all columns).

Output:

  • Columns (object-array): Array of column objects. Each column contains ID, name, type, display name, and other metadata.
  • NextPageToken (string): Opaque token for fetching the next page of results. If empty, there are no more results. Pass this as PageToken parameter to get the next page.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Get a Column

Get details of a specific column in a Coda table.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • TableId: Coda table ID or name (ID recommended). Get from List_Tables or table URL. Names are discouraged as they are fragile and prone to being changed by users. If you're using a name, ensure it is URI-encoded.
  • ColumnId: Coda column ID or name (ID recommended). Get from List_Columns. Names are discouraged as they are fragile and prone to being changed by users. If you're using a name, ensure it is URI-encoded.

Output:

  • Column (object): Column details including ID, name, type, display name, and other metadata.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Create a Row

Create a new row in a Coda table.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Doc or document URL: https://coda.io/d/{DocId}/...
  • TableId: Coda table ID or name (ID recommended, names are fragile). Get from List_Tables or table URL. Only supports base tables, not views. If you're using a name, be sure to URI-encode it.
  • Rows: Row data to insert/upsert. Supports two formats:1. JSON Object Array (recommended): - Format: '[{"ColumnName": "value", ...}, ...]' - Keys can be column names or column IDs - Example: '[{"Name": "John", "Email": "john@x.com"}]' - Example with IDs: '[{"col-abc123": "John", "col-def456": "john@x.com"}]'2. CSV String (auto-mapped to table column order): - Format: 'value1,value2\nvalue3,value4' - Values are mapped left-to-right to your table columns - Example: 'apple,100,8.88' (auto-fetches columns and maps to 1st, 2nd, 3rd column) - NOTE: CSV format will auto-fetch table columns to determine column IDs.

Options:

  • KeyColumns: Optional: Comma-separated column names or IDs for upsert (INSERT OR UPDATE). When provided, rows matching these key columns are updated. If omitted, always inserts new rows. Example: 'Email' or 'id' or 'col-abc123,col-def456'.
  • DisableParsing: Optional: Boolean flag. If true, Coda API will not parse cell values (all treated as strings). Default false = API auto-parses numbers, dates, etc. Useful when you want to preserve exact string formatting.

Output:

  • RequestId (string): Async request ID returned by Coda API (HTTP 202 accepted). Use this with GetMutationStatus to check when operation completes. If null, operation completed immediately.
  • AddedRowIds (string-array): Array of row IDs for newly added rows. Only populated when keyColumns is not set or empty (insert-only mode). When upserting (keyColumns set), this may be empty if all rows were updates rather than inserts.
  • StatusCode (number): HTTP status code (company-standardized to 200 for success). Official API returns 202 Accepted, we convert to 200. 400/401/403/404/429/500+ for errors.
  • ErrorMessage (string): Error details if StatusCode is not 200. StatusCode indicates error type: 400=bad request, 401=unauthorized, 403=forbidden, 404=not found, 429=rate limited, 500+=server error. ErrorMessage contains detailed explanation.

Delete a Row

Delete a specific row from a Coda table.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Doc or document URL: https://coda.io/d/{DocId}/...
  • TableId: Coda table ID or name (ID recommended). Get from List_Tables or table URL. If using name, ensure it's URI-encoded. Names are fragile and prone to change.
  • RowId: Coda row ID or name (ID recommended). Get from Get_All_Rows. If using name, ensure it's URI-encoded. If multiple rows have same name, arbitrary one is selected.

Output:

  • IsDeleted (bool): Whether the row was successfully deleted (true if deletion is queued for processing).
  • RequestId (string): Async request ID for the deletion operation. Use with Get Mutation Status to check when deletion completes.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 500+ (server error).
  • ErrorMessage (string): Error details if StatusCode is not 200. StatusCode identifies error type, ErrorMessage provides details.

Get All Rows

Get all rows from a Coda table.

Input Parameters:

  • DocId: Coda document ID. Can be found in the document URL: https://coda.io/d/{DocId}/...
  • TableId: Coda table ID or name. Get it from the table URL or use Get_a_Table action.

Options:

  • Query: Optional: Filter rows using query syntax. Format: column_id_or_name:value - Example: 'Email:"john@example.com"' (exact match with quotes for strings) - Example: 'Status:"Active"' (use column name with quotes if preferred) - Example: 'Price:>100' (numeric comparison) - To use column names instead of IDs, quote them: '"Full Name":"John"'.
  • SortBy: Optional: Sort order of returned rows. Default is 'createdAt' (ascending). - 'createdAt': Sort by creation time (default) - 'updatedAt': Sort by last update time - 'natural': Sort by row order in table view (visibleOnly=true).
  • UseColumnNames: Optional: If true, use column names instead of column IDs in output. Default false (not recommended as names are fragile). Example: column 'Name' instead of 'col-abc123'.
  • ValueFormat: Optional: Format of returned cell values. Default 'simple'. - 'simple': Plain values (numbers, strings, etc.) - 'simpleWithArrays': Supports array/reference fields - 'rich': Full formatting info (colors, formulas, etc.).
  • VisibleOnly: Optional: If true, return only visible rows (filtered/sorted view). Default false (all rows).
  • Limit: Optional: Maximum rows per page (1-100). Default 25. Larger values reduce API calls but use more memory.
  • PageToken: Optional: Pagination token from previous response's nextPageToken. Use this instead of offset for better pagination. Omit for first page.
  • SyncToken: Optional: Sync token from previous response. Use for incremental updates - returns only rows changed since last call.

Output:

  • Rows (object-array): Array of row objects. Each row contains: id (string, unique row ID), cells (array of cell values), createdTime (ISO 8601), updatedTime (ISO 8601). Structure depends on valueFormat parameter.
  • NextPageToken (string): Pagination token for fetching next page of results. Pass this as PageToken parameter in next call. Empty string means no more pages available.
  • SyncToken (string): Sync token for incremental updates. Pass this as SyncToken parameter in next call to fetch only rows changed since this call. Useful for continuous synchronization.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request - invalid query/params), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 500+ (server error).
  • ErrorMessage (string): Error details if StatusCode is not 200. Includes ErrorType field (INVALID_REQUEST, INVALID_TOKEN, etc.) and raw API error message for troubleshooting.

Get a Row

Get a specific row from a Coda table.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Doc or document URL: https://coda.io/d/{DocId}/...
  • TableId: Coda table ID or name (ID recommended). Get from List_Tables or table URL.
  • RowId: Coda row ID or name (ID recommended). Get from Get_All_Rows. If multiple rows have same name, arbitrary one is selected.

Options:

  • UseColumnNames: Optional: If true, use column names instead of column IDs in output. Default false (not recommended as names are fragile).
  • ValueFormat: Optional: Format of returned cell values. Default 'simple'. Values: 'simple' (plain values), 'simpleWithArrays' (supports arrays), 'rich' (with formatting).

Output:

  • Row (object): The specific row object containing all cell values with their column IDs or names (depending on useColumnNames parameter). Structure: {id, cells, createdTime, updatedTime}.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 500+ (server error).
  • ErrorMessage (string): Error details if StatusCode is not 200. StatusCode identifies error type, ErrorMessage provides details.

Push a Button

Push a button in a Coda row.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • TableId: Coda table ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it.
  • RowId: Coda row ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it. Get from Get_All_Rows or Get_a_Row.
  • ButtonColumnId: Coda button column ID or name. This column must be of type 'button'. ID is strongly recommended over name. If using a name, be sure to URI-encode it. Get from Get_All_Columns.

Output:

  • Success (bool): Boolean flag indicating if the button push was successfully queued (True = button action queued, False = failed). Note: True does not mean the button action completed, only that it was accepted for asynchronous processing.
  • RequestId (string): Request ID from Coda API response header. Can be used to track the button action execution or for debugging.
  • StatusCode (number): HTTP status code: 200 (success - 202 converted), 400 (bad request or button column type invalid), 401 (unauthorized), 403 (forbidden - missing write permission), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type. Common issues: button column is not of type 'button', missing write permissions, or IDs are invalid.

Get Many Views

Get all views from a Coda document.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...

Options:

  • Limit: Optional: Maximum number of results to return in this query. Default: 25.
  • PageToken: Optional: Opaque token used to fetch the next page of results. Returned as 'NextPageToken' in previous response. Pass this to get the next page.
  • SortBy: Optional: Determines how to sort the results. Default: 'name'. Currently supports 'name' for alphabetical sorting by view name.

Output:

  • Views (object-array): Array of view objects (filtered from tables where tableType='view'). Each view represents an alternative representation of a base table.
  • NextPageToken (string): Opaque token for fetching the next page of results. If empty, there are no more results. Pass this as PageToken parameter to get the next page.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Get a View

Get a specific view from a Coda document.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • ViewId: Coda view ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it. Get from Get_Many_Views.

Output:

  • View (object): The view object if tableType is 'view'. Contains id, name, tableType, createdAt, updatedAt, and layout fields. Empty object if the specified ID is not a view.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request or not a view), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Get All View Columns

Get all columns from a Coda view.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • ViewId: Coda view ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it. Get from Get_Many_Views.

Options:

  • Limit: Optional: Maximum number of results to return in this query. Range: 1-100. Default: 25.
  • PageToken: Optional: Opaque token used to fetch the next page of results. Returned as 'NextPageToken' in previous response. Pass this to get the next page.
  • VisibleOnly: Optional: If true, returns only visible columns for the view. This parameter only applies to base tables and views (not applicable for some view types). Default: false.

Output:

  • Columns (object-array): Array of column objects from the view. Each column contains id, name, type, and display properties. Note: Views use the same columns as their underlying base table.
  • NextPageToken (string): Opaque token for fetching the next page of results. If empty, there are no more results. Pass this as PageToken parameter to get the next page.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Delete a View Row

Delete a specific row from a Coda view.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • ViewId: Coda view ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it. Get from Get_Many_Views.
  • RowId: Coda row ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it. Get from Get_All_Rows or Get_a_View_Row.

Output:

  • IsDeleted (bool): Boolean flag indicating if the row deletion was successfully queued (True = deletion queued, False = failed). Note: True means deletion is queued for asynchronous processing, not necessarily completed.
  • RequestId (string): Request ID from Coda API response header. Can be used to track the deletion operation or for debugging.
  • StatusCode (number): HTTP status code: 200 (success - 202 converted), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Get a View Row

Get a specific row from a Coda view.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • ViewId: Coda view ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it. Get from Get_Many_Views.
  • RowId: Coda row ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it.

Options:

  • UseColumnNames: Optional: Use column names instead of column IDs in the returned values object. Default: false. Note: Using names is fragile - if columns are renamed, code may break. Use IDs for reliability.
  • ValueFormat: Optional: Format for returned cell values. Enum: 'simple' (default), 'simpleWithArrays' (preserve array values), 'rich' (formatted text). Default: 'simple'.

Output:

  • Row (object): The row object containing id, values (column ID/name mapped to cell values), name, index, createdAt, updatedAt, and parent (view/table reference). Some columns like buttons or canvas may be empty or incomplete.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request or invalid parameters), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Push a View Button

Push a button in a Coda view row.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • ViewId: Coda view ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it. Get from Get_Many_Views.
  • RowId: Coda row ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it. Get from Get_All_Rows or Get_a_View_Row.
  • ButtonColumnId: Coda button column ID or name. This column must be of type 'button'. ID is strongly recommended over name. If using a name, be sure to URI-encode it. Get from Get_All_View_Columns.

Output:

  • Success (bool): Boolean flag indicating if the button push was successfully queued (True = button action queued, False = failed). Note: True does not mean the button action completed, only that it was accepted for asynchronous processing.
  • RequestId (string): Request ID from Coda API response header. Can be used to track the button action execution or for debugging.
  • StatusCode (number): HTTP status code: 200 (success - 202 converted), 400 (bad request or button column type invalid), 401 (unauthorized), 403 (forbidden - missing write permission), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type. Common issues: button column is not of type 'button', missing write permissions, or IDs are invalid.

Update a View Row

Update a specific row in a Coda view.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • ViewId: Coda view ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it. Get from Get_Many_Views.
  • RowId: Coda row ID or name. ID is strongly recommended over name as names can be changed by users. If using a name, be sure to URI-encode it. Get from Get_All_Rows or Get_a_View_Row.
  • Values: Values to update in two supported formats: 1) CSV format: 'ColumnName1,ColumnName2,ColumnName3' (line 1) + 'value1,value2,value3' (line 2) 2) Key-value format: 'ColumnName: value' separated by newlines. Example: 'Name: Alice\nAge: 30\nStatus: Active' Supports column names or IDs. Also supports Chinese colons (:) in key-value format.

Options:

  • DisableParsing: Optional: If true, disables data type parsing and treats all values as strings. Default: false.

Output:

  • UpdatedRow (object): The updated row object containing id, values (column ID/name mapped to cell values), name, index, createdAt, updatedAt. Reflects the state after asynchronous update processing.
  • RequestId (string): Request ID from Coda API response header. Can be used to track the update operation or for debugging.
  • StatusCode (number): HTTP status code: 200 (success - 202 converted), 400 (bad request or invalid column/values), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type. Common issues: invalid key-value format, non-existent columns, type mismatch, or permission issues.

Get Many Controls

Get all controls from a Coda document.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...

Options:

  • Limit: Optional: Maximum number of results to return in this query. Default: 25, Maximum: varies by endpoint.
  • PageToken: Optional: Opaque token used to fetch the next page of results. Returned as 'NextPageToken' in previous response. Pass this to get the next page.
  • SortBy: Optional: Determines how to sort the results. Default: 'name'. Currently supports 'name' for alphabetical sorting by control name.

Output:

  • Controls (object-array): Array of control objects. Each control contains ID, name, type, and other metadata.
  • NextPageToken (string): Opaque token for fetching the next page of results. If empty, there are no more results. Pass this as PageToken parameter to get the next page.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Get a Control

Get a specific control from a Coda document.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • ControlId: Coda control ID or name (ID recommended). Get from Get_Many_Controls. Names are discouraged as they are fragile and prone to being changed by users. If you're using a name, ensure it is URI-encoded.

Output:

  • Control (object): Control details including ID, name, type, value, and other metadata.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Get Many Formulas

Get all formulas from a Coda document.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...

Options:

  • Limit: Optional: Maximum number of results to return in this query. Default: 25.
  • PageToken: Optional: Opaque token used to fetch the next page of results. Returned as 'NextPageToken' in previous response. Pass this to get the next page.
  • SortBy: Optional: Determines how to sort the results. Default: 'name'. Currently supports 'name' for alphabetical sorting by formula name.

Output:

  • Formulas (object-array): Array of formula objects. Each formula contains ID, name, type, and other metadata.
  • NextPageToken (string): Opaque token for fetching the next page of results. If empty, there are no more results. Pass this as PageToken parameter to get the next page.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.

Get a Formula

Get a specific formula from a Coda document.

Input Parameters:

  • DocId: Coda document ID. Get from Get_All_Docs or document URL: https://coda.io/d/{DocId}/...
  • FormulaId: Coda formula ID or name (ID recommended). Get from Get_Many_Formulas. Names are discouraged as they are fragile and prone to being changed by users. If you're using a name, ensure it is URI-encoded.

Output:

  • Formula (object): Formula details including ID, name, type, and other metadata.
  • RequestId (string): Request ID from Coda API response header, can be used for debugging.
  • StatusCode (number): HTTP status code: 200 (success), 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 503 (service unavailable), 504 (timeout).
  • ErrorMessage (string): Error message with details if operation failed. StatusCode indicates error type.
Was This Page Helpful?
Discussion

Leave a Reply.

Your email address will not be published. Required fields are marked*

loading...
No Results