Skip to main content
Coda logo
  • Category: productivity
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 110
  • Triggers: 4
  • Slug: CODA
  • Version: 20261101_00

Tools

Slug: CODA_ADD_A_CATEGORY_FOR_PACKAdd a publishing category for a given pack.

Input Parameters

integer
required
ID of a Pack
string
required
Name of the publishing category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_ADD_A_MAKER_FOR_PACKAdd a maker to a Pack. Makers are users who are displayed as contributors on the Pack’s public listing page. You must be an owner or admin of the Pack to add makers. This is typically used to credit collaborators and team members who contributed to the Pack’s development.

Input Parameters

integer
required
The unique identifier of the Pack. You must have admin/owner permissions on this Pack to add makers.
string
required
The email address (login ID) of the user to add as a Pack maker. This user will be displayed as a maker on the Pack’s public listing page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_ADD_A_PERMISSION_FOR_PACKCreate or modify permissions for a given Pack. This action allows you to grant access to a Pack for users or workspaces. If a permission already exists for the specified principal, it will be updated with the new access level. The API returns a permission ID which is the same for updates to existing permissions. Note: You must have admin access to the Pack to manage its permissions.

Input Parameters

string ("view" | "test" | "edit" | "admin")
required
Access level to grant for the Pack. Options: - ‘view’: Can view the Pack and its details. - ‘test’: Can test the Pack in their docs. - ‘edit’: Can modify the Pack (requires maker permissions). - ‘admin’: Full administrative access to the Pack.
integer
required
ID of a Pack
object
required
Metadata about a Pack principal. Must be a dictionary specifying who gets the permission. Supported types: 1) Workspace: {“type”: “workspace”, “workspaceId”: “ws-xxx”} - Grant permission to an entire workspace. 2) User (email): {“type”: “email”, “email”: “user@example.com”} - Grant permission to a specific user by email. Note: Not all principal types may be supported depending on pack configuration and user permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_ADD_CUSTOM_DOMAINAdd a custom domain to a published doc. This action allows you to map a custom domain (like ‘docs.yourcompany.com’) to a published Coda doc. Before using this action: 1. The doc must be published (use CODA_PUBLISH_DOC action first) 2. Your Coda account must have a paid plan (Pro, Team, or Enterprise) 3. You’ll need to configure DNS settings at your domain registrar after adding the domain The domain setup typically takes 5-10 minutes to initialize after DNS is configured. You can check the status using CODA_LIST_CUSTOM_DOC_DOMAINS action. Note: Custom domains are NOT available on Coda’s Free tier.

Input Parameters

string
required
The unique identifier of the Coda doc to which the custom domain will be added. The doc must be published before adding a custom domain. Example: ‘dG7v27oLhI’
string
required
The custom domain name to add to the published doc (e.g., ‘docs.example.com’ or ‘www.mysite.com’). You must configure DNS settings at your domain registrar to point to Coda’s servers before the domain will be fully functional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_ADD_PERMISSIONAdds a new permission to the doc.

Input Parameters

string
required
ID of the doc.
string ("readonly" | "write" | "comment")
required
Type of access to grant. ‘readonly’ allows viewing only, ‘write’ allows editing, ‘comment’ allows commenting.
object
required
The user, group, domain, or anyone principal to grant access to. Use type=‘email’ with email field for individual users, type=‘group’ with groupId for groups, type=‘domain’ with name for domain access, or type=‘anyone’ for public access.
boolean
When true, suppresses email notification to the principal about the new permission. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_BEGIN_CONTENT_EXPORTInitiate an asynchronous export of page content in HTML or Markdown format. This action starts a content export job and returns immediately with a request ID and status URL. The export is processed asynchronously. Use the returned ‘href’ URL with the ‘content_export_status’ action to poll for completion and retrieve the exported content.

Input Parameters

string
required
Unique identifier of the Coda document containing the page to export.
string ("html" | "markdown")
required
Output format for the exported page content. Supported formats are ‘html’ (preserves rich formatting) and ‘markdown’ (provides plain text representation).
string
required
ID or name of the page to export. Page IDs are recommended (format: ‘canvas-XXXXXXXX’) as they are stable. Names can be used but should be URI-encoded and may be ambiguous if multiple pages share the same name. When multiple pages have the same name, an arbitrary one will be selected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_CONTENT_EXPORT_STATUSCheck the status of a page content export operation. Use this to poll the export status and retrieve the download link when the export completes.

Input Parameters

string
required
The unique identifier of the Coda document containing the page.
string
required
The unique identifier of the content export request, obtained from the ‘Begin content export’ action.
string
required
ID or name of the page. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_COPY_DOCCreates a copy of an existing Coda document. This action allows you to duplicate a document while optionally specifying a new title and location for the copied document.

Input Parameters

string
Title for the new document. If not specified, defaults to ‘Untitled’.
string
The timezone to use for the newly created document.
string
The ID of the folder where the new document will be created. If not specified, defaults to your ‘My docs’ folder.
string
required
ID of the existing document to copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_CREATE_A_NEW_PACK_RELEASECreates a new Pack release based on an existing Pack version.

Input Parameters

integer
required
ID of a Pack
string
required
The semantic version of the Pack to release (e.g., ‘1.0.0’, ‘1.2.3’). Must be an existing Pack version.
string
Optional release notes describing changes, improvements, or fixes in this release.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_CREATE_A_PAGECreate a new page in a doc. Note that creating a page requires you to be a Doc Maker in the applicable workspace.

Input Parameters

string
Name of the page.
string
required
ID of the doc.
string
Name of the icon.
string
Url of the cover image to use.
string
Subtitle of the page.
string
Content for the page. Must be a discriminated union with a ‘type’ field. Valid types: ‘canvas’ for text/rich text content, ‘embed’ for full-page embeds. For canvas: {‘type’: ‘canvas’, ‘canvasContent’: {‘format’: ‘html’|‘markdown’, ‘content’: ’…’}}. For embed: {‘type’: ‘embed’, ‘url’: ‘https://…’}. NOTE: Tables cannot be created via pageContent - use separate table insertion APIs after page creation.
string
The ID of this new page”s parent, if creating a subpage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_CREATE_DOCCreates a new Coda doc, optionally copying an existing doc. Note that creating a doc requires you to be a Doc Maker in the applicable workspace (or be auto-promoted to one).

Input Parameters

string
Title of the new doc. Defaults to “Untitled”.
string
The ID of the folder within which to create this doc. Defaults to your “My docs” folder in the oldest workspace you joined; this is subject to change. You can get this ID by opening the folder in the docs list on your computer and grabbing the folderId query parameter.
string
The timezone to use for the newly created doc.
string
An optional doc ID from which to create a copy.
object
The initial page to create in the doc. Can include properties like ‘name’ (page title), ‘subtitle’, ‘iconName’, ‘imageUrl’, ‘parentPageId’, and ‘pageContent’ (with ‘type’: ‘canvas’ and ‘canvasContent’ containing HTML). This allows you to pre-configure the first page of the newly created document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_CREATE_FOLDERCreates a new folder in a Coda workspace. Use this action to organize documents by creating folders within a workspace. Folders help structure content and make it easier to navigate and manage documents.

Input Parameters

string
required
Name of the folder to create.
string
Description of the folder to provide context about its purpose.
string
required
ID of the workspace where the folder should be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_CREATE_PACKCreates a new Pack in Coda. A Pack is a container for custom functionality that extends Coda’s capabilities. This endpoint registers a new Pack and returns its ID. After creation, you’ll need to separately upload the Pack’s source code and assets. Prerequisites: - You must have appropriate permissions in the target workspace - The workspace must allow Pack creation Next steps after creation: 1. Upload Pack source code using the upload pack source code endpoint 2. Upload Pack assets (logos, images) using the upload pack asset endpoint 3. Register a Pack version to make it available for use

Input Parameters

string
required
The name for the Pack. This is a required field and will be displayed to users when they browse or search for Packs. Should be descriptive and unique within your workspace. Can be an empty string but it’s recommended to provide a meaningful name.
string
A brief description of what the Pack does and its purpose. This helps users understand the Pack’s functionality. Optional but recommended for better discoverability. Can include details about features, use cases, or any special requirements.
string
The parent workspace ID where the Pack will be created. If not specified, the Pack will be created in the authenticated user’s default workspace. You can obtain workspace IDs from the user info or list docs endpoints.
integer
The ID of an existing Pack to fork/copy from. Use this when creating a new Pack based on an existing one. The new Pack will inherit the source Pack’s code and configuration. Leave empty for creating a Pack from scratch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_CREATE_PACK_INVITATIONCreate an invitation for a user to access a Pack. This action sends an invitation to the specified email address, granting them access to the Pack at the specified access level. The invitee will receive an email notification with instructions to accept the invitation. Prerequisites: - You must have appropriate permissions (admin or owner) on the Pack to create invitations - The email address must be valid Note: The invitation must be accepted by the recipient to grant them actual access to the Pack.

Input Parameters

string
required
Email address of the user to invite to the Pack. The invitation will be sent to this email address.
string ("none" | "view" | "test" | "edit" | "admin")
required
Access level to grant for the Pack. Options: ‘none’ - No access, ‘view’ - Can view the Pack and its details, ‘test’ - Can test the Pack in their docs, ‘edit’ - Can modify the Pack (requires maker permissions), ‘admin’ - Full administrative access to the Pack.
integer
required
ID of the Pack to create an invitation for. You must have appropriate permissions on this Pack to create invitations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_A_CATEGORY_FOR_PACKDelete a publishing category for a given pack.

Input Parameters

integer
required
ID of a Pack
string
required
Name of a publishing category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_A_MAKER_FOR_PACKRemoves a maker from a Pack’s maker list. The maker will no longer be displayed as a contributor on the Pack’s public page. This action requires admin access to the Pack. The operation returns successfully even if the maker was not previously listed for the Pack.

Input Parameters

integer
required
The unique numeric identifier of the Pack from which to remove the maker.
string
required
The email address of the maker to be removed from the Pack’s maker list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_A_PAGEDeletes the specified page.

Input Parameters

string
required
ID of the doc.
string
required
ID or name of the page. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_A_PERMISSION_FOR_PACKDelete user, workspace, or global permissions for a given Pack.

Input Parameters

integer
required
ID of a Pack
string
required
ID of a permission on a pack.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_DOCPermanently deletes a Coda doc. This action permanently removes the specified doc and all its contents including pages, tables, formulas, and data. The deletion is processed asynchronously and returns immediately with a 202 Accepted status. The doc will be fully deleted within a few seconds. Warning: This is a destructive operation that cannot be undone. Ensure you have the correct doc ID before executing this action. Permissions: You must be the owner of the doc or have appropriate deletion permissions. Error Responses: - 404: The doc does not exist or you don’t have access to it - 401: Invalid or expired API token - 403: You don’t have permission to delete this doc

Input Parameters

string
required
The unique identifier of the doc to delete. This is the alphanumeric ID found in the doc’s URL (e.g., ‘AbCDeFGH’ from https://coda.io/d/_dAbCDeFGH).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_FOLDERTool to delete a folder in Coda. Use when you need to permanently remove a folder. This operation deletes the specified folder.

Input Parameters

string
required
ID of the folder to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_MULTIPLE_ROWSDeletes multiple rows from a Coda table or view. This action queues the specified rows for deletion and returns immediately with a 202 status. The actual deletion is processed asynchronously and typically completes within several seconds. Use the returned requestId with the getMutationStatus endpoint to verify completion if needed.

Input Parameters

string
required
ID of the Coda document containing the table with rows to delete.
array
required
Array of row IDs to delete from the table. Each ID should be in the format ‘i-xxxxxxxxxx’.
string
required
ID or name of the table containing the rows to delete. Table IDs (e.g., ‘grid-abc123’) are recommended over names since names can be changed by users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_PACKDelete a given Pack.

Input Parameters

integer
required
ID of a Pack

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_PACK_LISTING_DRAFTDelete the listing draft for a Pack, discarding any unsaved changes. Tool to delete the listing draft for a Pack, discarding any unsaved changes. Use when you need to discard a draft listing for a Pack without publishing it. This removes the draft version and reverts to the last published listing (if any). Important: This action permanently discards all unpublished changes to the Pack listing. To publish changes instead of discarding them, use the appropriate publish action.

Input Parameters

integer
required
ID of the Pack whose listing draft should be deleted. This is the unique numeric identifier assigned when the Pack was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_PAGE_CONTENTDelete specific content elements or all content from a Coda page; omitting element IDs or providing an empty list deletes all page content. The deletion is queued for processing.

Input Parameters

string
required
ID of the doc containing the page.
array
IDs of the elements to delete from the page. If omitted or empty, all content will be deleted.
string
required
ID or name of the page. Names are discouraged because they’re easily prone to being changed by users. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected. Note: URI encoding is handled automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_PERMISSIONDeletes an existing permission from a Coda document. This action permanently removes access for a specific user, group, or domain that was previously granted to the document. To use this action, you must first obtain the permissionId from the LIST_PERMISSIONS action. The deletion is immediate and cannot be undone through the API. Common use cases: - Revoking access when a user no longer needs to view/edit the document - Managing document security by removing obsolete permissions - Cleaning up permissions after organizational changes Note: This action requires appropriate permissions to manage document access.

Input Parameters

string
required
The unique identifier of the Coda document from which to delete the permission. Can be obtained from LIST_AVAILABLE_DOCS or CREATE_DOC actions.
string
required
The unique identifier of the permission to delete. This ID can be retrieved from the LIST_PERMISSIONS action. Each permission represents access granted to a specific user, group, or domain for the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETE_ROWDeletes the specified row from the table or view. This endpoint will always return a 202, so long as the row exists and is accessible (and the update is structurally valid). Row deletions are generally processed within several seconds. When deleting using a name as opposed to an ID, an arbitrary row will be removed.

Input Parameters

string
required
ID of the doc.
string
required
ID or name of the row. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it. If there are multiple rows with the same value in the identifying column, an arbitrary one will be selected.
string
required
ID or name of the table. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_DELETES_A_CUSTOM_DOMAINDeletes a custom domain from a published doc.

Input Parameters

string
required
ID of the Coda doc from which to remove the custom domain. Example: ‘rqC5QoVKYT’
string
required
The custom domain name to delete (e.g., ‘example.com’, ‘docs.mycompany.io’). Note: The API returns 200 OK even if the domain doesn’t exist on the doc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_FETCH_GROUPED_LOGS_BY_PACK_ORG_ROOT_INGESTION_IDRetrieves grouped logs for a Pack ingestion for debugging, with optional filtering and pagination. A 404 response is returned as an empty list, so an empty result does not distinguish a missing resource from a response with no logs.

Input Parameters

string
A search query that follows Lucene syntax.
integer
Maximum number of results to return in this query.
string ("asc" | "desc")
Specifies if the logs will be returned in time desc or asc. Default is desc.
integer
required
ID of a Pack
string
An opaque token used to fetch the next page of results.
string
Only return logs after the given time (non-inclusive).
string
required
ID of the organization.
string
Only return logs before the given time (non-inclusive).
string
required
ID of the root ingestion.
string
ID of the ingestion execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_FETCH_INGESTION_EXECUTIONS_FOR_PACKRetrieves ingestion executions for a Pack and root ingestion for debugging, with optional filtering and pagination. A 404 response is returned as an empty list, so an empty result does not distinguish a missing resource from a response with no executions.

Input Parameters

integer
Maximum number of results to return in this query.
string ("asc" | "desc")
Sort order for ingestion executions by time: ‘asc’ (ascending/oldest first) or ‘desc’ (descending/newest first). Default is ‘desc’.
integer
required
ID of a Pack
string
An opaque token used to fetch the next page of results.
string
Filter results by datasource name (e.g., the external data source being ingested).
string ("FULL" | "INCREMENTAL")
Filter results by execution type: ‘FULL’ (complete data sync) or ‘INCREMENTAL’ (delta/changes only).
string
Only return ingestion executions after the given time (non-inclusive). Format: ISO 8601 timestamp.
string
Filter results by specific CSB (Coda Sync Bridge) ingestion ID.
string
required
ID of the organization. This is an Enterprise-level identifier used with Coda Brain features.
string
Only return ingestion executions before the given time (non-inclusive). Format: ISO 8601 timestamp.
string ("QUEUED" | "STARTED" | "CANCELLED" | "UP_FOR_RETRY" | "COMPLETED" | "FAILED")
Filter results by ingestion execution status. Options: QUEUED, STARTED, CANCELLED, UP_FOR_RETRY, COMPLETED, FAILED.
string
required
ID of the root ingestion. This identifies a specific data ingestion process in Coda Brain.
string
Filter results by specific CSB (Coda Sync Bridge) ingestion execution ID.
boolean
Include deleted ingestion executions in the response. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_ACL_SETTINGSReturns settings associated with ACLs for this Coda doc.

Input Parameters

string
required
ID of the doc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_A_COLUMNReturns detailed information about a specific column in a Coda table. Retrieves column metadata including: - Column ID, name, type, and href - Format details (type, isArray, label, action, displayType, etc.) - Whether it’s a display column or calculated column - Formula (for calculated columns) - Default value - Parent table and page information

Input Parameters

string
required
ID of the Coda document.
string
required
ID or name of the table. Names are discouraged because they’re easily prone to being changed by users. If you’re using a name, be sure to URI-encode it.
string
required
ID or name of the column. Names are discouraged because they’re easily prone to being changed by users. If you’re using a name, be sure to URI-encode it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_A_CONTROLReturns info on a control.

Input Parameters

string
required
ID of the doc.
string
required
ID or name of the control. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_A_FORMULAReturns info on a formula.

Input Parameters

string
required
ID of the doc.
string
required
ID or name of the formula. Names are discouraged because they’re easily prone to being changed by users. If you’re using a name, be sure to URI-encode it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_ANALYTICS_LAST_UPDATED_DAYReturns days based on Pacific Standard Time when analytics were last updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_A_PAGEReturns details about a page.

Input Parameters

string
required
ID of the doc.
string
required
ID or name of the page. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_A_ROWRetrieves detailed information about a specific row in a Coda table, including all cell values, metadata (creation/update timestamps), and parent table information. Use this action when you need to read data from a specific row in a Coda document.

Input Parameters

string
required
Unique identifier of the Coda document containing the table and row.
string
required
ID or name of the row to retrieve. Row IDs (e.g., ‘i-xyz123’) are recommended over names as names can be changed by users. If using a name, ensure it is properly URI-encoded. If multiple rows have the same name value, an arbitrary one will be returned.
string ("simple" | "simpleWithArrays" | "rich")
Format for cell values in the response. Options: ‘simple’ (default) returns primitive types (string/number/boolean) with arrays as comma-delimited strings; ‘simpleWithArrays’ returns arrays as JSON arrays; ‘rich’ returns values with full encoding including Markdown for text and structured data for complex types (currency, person, image, etc.).
string
required
ID or name of the table containing the row. Table IDs (e.g., ‘grid-xyz123’) are recommended over names as names can be changed by users. If using a name, ensure it is properly URI-encoded.
boolean
When true, returns column names as keys in the values object instead of column IDs. Default is false. Using column IDs is recommended as column names can be changed by users, which may break integrations relying on specific names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_A_SINGLE_PACKRetrieves details of a specific Coda Pack by its ID, including its name, description, workspace, and available logo and rate-limit information.

Input Parameters

integer
required
The unique identifier of the Pack to retrieve. Must be a Pack that the authenticated user has created or has access to. You can obtain Pack IDs by creating a new Pack with the ‘create_pack’ action or by listing accessible Packs with the ‘list_packs’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_A_TABLEReturns details about a specific table or view.

Input Parameters

string
required
ID of the doc.
string
required
ID or name of the table. Names are discouraged because they’re easily prone to being changed by users. If you’re using a name, be sure to URI-encode it.
boolean
Return “detail” and “form” for the layout field of detail and form layouts respectively (instead of “masterDetail” for both)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_DETAILED_LISTING_INFORMATION_FOR_A_PACKGet comprehensive public listing information for a Coda Pack. Returns detailed metadata about a Pack including its description, logo, categories, makers, pricing, version information, and user access permissions. This endpoint provides the same information displayed on the Pack’s public listing page in the Coda Pack gallery. Optionally accepts workspace/document context to check installation privileges and release channel to retrieve specific versions (LIVE or LATEST).

Input Parameters

string
Optional document ID to check installation privileges for that specific document. If provided, the response will include user access permissions relative to this document.
integer
required
ID of the Pack to retrieve detailed listing information for.
string
Optional workspace ID to check installation privileges in that specific workspace. If provided, the response will include user access permissions relative to this workspace.
string ("workspace" | "doc")
Optional installation context type (workspace or doc) to specify where the Pack would be installed. When provided, must be accompanied by the corresponding workspaceId (if context is ‘workspace’) or docId (if context is ‘doc’). Affects the userAccess permissions returned in the response.
string ("LIVE" | "LATEST")
Optional release channel to retrieve Pack information for. LIVE returns the current live/production version, LATEST returns the most recently uploaded version (may be unpublished).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_DOC_ANALYTICS_SUMMARYReturns aggregated analytics summary data across documents, including session counts, installs, copies, reads, and conversions. Can be filtered by publication status, date range, and workspace.

Input Parameters

string
Limit results to activity on or after this date. Format: YYYY-MM-DD (e.g., ‘2025-01-01’).
string
Limit results to activity on or before this date. Format: YYYY-MM-DD (e.g., ‘2025-12-31’).
boolean
Limit results to only published items.
string
ID of the workspace to filter analytics. If not specified, returns analytics for all accessible workspaces.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_DOC_CATEGORIESRetrieves the list of all available doc categories in Coda. These categories can be used when publishing docs to help users discover content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_FOLDERTool to get metadata about a Coda folder. Use when you need to retrieve information about a specific folder including its name, description, icon, workspace, and editing permissions.

Input Parameters

string
required
ID of the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_INFO_ABOUT_A_DOCRetrieves comprehensive metadata for a specific Coda document. This action returns detailed information about a document including its name, owner, creation/update timestamps, workspace and folder location, size metrics (page count, row count, table count), icon, publication status, and source document reference if the doc was copied from another. This is useful for understanding document properties, discovering document structure, and tracking document relationships.

Input Parameters

string
required
The unique identifier of the Coda document. This is the document ID visible in the URL (e.g., ‘abc123XYZ’ from ‘https://coda.io/d/_dabc123XYZ’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_MUTATION_STATUSChecks whether an asynchronous mutation operation has been applied to a Coda document. When you perform mutations like inserting/updating rows, deleting rows, or pushing buttons, the Coda API returns a 202 status with a requestId. These operations are queued and processed asynchronously (usually within a few seconds). Use this tool to verify that your mutation has been successfully applied before proceeding with dependent operations. Important notes: - Mutation status information is only available for about 24 hours after completion - This should be used shortly after the mutation request was made - Returns completed=true when the operation has finished, completed=false if still pending

Input Parameters

string
required
The unique request identifier returned from a mutation operation (e.g., ‘mutate:c39bd6d9-2719-40e4-bd21-110f3c520031’). This ID is provided in the response from mutation endpoints like upsert rows, delete row, or push button.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_PACK_ANALYTICS_SUMMARYReturns summarized analytics data for Packs the user can edit. This endpoint provides aggregate statistics including: - Total Pack invocations across all accessible Packs - Total document installations - Total workspace installations All query parameters are optional. If no filters are specified, returns analytics for all Packs the authenticated user can edit.

Input Parameters

array
Which Pack IDs to fetch. Note: This parameter may not be supported by the API endpoint.
string
Limit results to activity on or after this date (ISO 8601 format, e.g., ‘2024-01-01’).
string
Limit results to activity on or before this date (ISO 8601 format, e.g., ‘2024-12-31’).
boolean
Limit results to only published Packs. If false or unspecified, returns analytics for all Packs including published ones.
string
ID of the workspace to filter analytics by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GETS_CUSTOM_DOC_DOMAINS_PROVIDERSIdentifies the domain registrar/provider for a given domain name by performing a DNS lookup. Returns the provider name (e.g., GoDaddy, Namecheap) or ‘Other’ if unidentified. Useful for determining where to configure DNS settings when setting up custom domains for published Coda docs.

Input Parameters

string
required
The domain name to check (e.g., ‘example.com’ or ‘docs.example.com’). Can be any valid domain; does not need to be configured in Coda.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_SHARING_METADATAReturns metadata associated with sharing for this Coda doc.

Input Parameters

string
required
ID of the doc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GETS_THE_JSON_SCHEMA_FOR_PACK_CONFIGURATIONRetrieves the JSON Schema that defines the configuration options available for a specific Coda Pack. This schema describes how the Pack can be customized, including connection settings, OAuth scopes, endpoint configurations, sharing permissions, and which Pack components (formulas, actions, sync tables) are available for use.

Input Parameters

integer
required
The unique numeric ID of the Coda Pack for which to retrieve the configuration schema. This ID can be obtained from the List Packs endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_THE_DIFFERENCE_BETWEEN_TWO_PACK_VERSIONSGets information about the difference between the specified previous version and next version of a Pack. This endpoint compares two semantic versions of a Pack and returns the differences. Both versions must exist for the specified pack.

Input Parameters

integer
required
ID of a Pack. Must be a pack you own or have access to.
string
required
Semantic version of the previous/base Pack version (e.g., ‘1.0.0’). This version must exist for the specified pack.
string
required
Semantic version of the new/target Pack version to compare against (e.g., ‘1.1.0’). This version must exist for the specified pack.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_THE_NEXT_VALID_VERSION_FOR_A_PACKGet the next valid version number for a Pack based on the proposed metadata. This endpoint validates the proposed Pack metadata and determines what the next semantic version number should be. It returns validation findings if there are any issues with the metadata. This is typically used before registering and uploading a new Pack version. Note: This endpoint only works with Packs that the authenticated user owns or has appropriate permissions to manage.

Input Parameters

integer
required
ID of a Pack
string
The SDK version the metadata was built on.
string
required
The metadata for the next version of the Pack as a JSON string. This typically includes Pack definition metadata such as formulas, sync tables, authentication configuration, and other Pack features. The API will validate this metadata and return the next valid version number along with any validation findings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_THE_SOURCE_CODE_FOR_A_PACK_VERSIONRetrieves temporary download URLs for the source code files of a specific Pack version. Returns pre-signed, time-limited URLs to download the original TypeScript/JavaScript source code. Useful for reviewing, auditing, backing up, or comparing Pack code between versions. Prerequisites: - Pack must exist and be accessible to the authenticated user - Version must have been created with source code uploaded - Use CODA_LIST_PACKS to find Pack IDs and CODA_LIST_THE_VERSIONS_FOR_A_PACK for versions Important: URLs expire within hours, so download files promptly. Returns empty array if no source code was uploaded for the version. This action only returns URLs, not file contents.

Input Parameters

integer
required
ID of the Pack to retrieve source code from. You can obtain Pack IDs by using CODA_LIST_PACKS or CODA_CREATE_PACK actions. The Pack must be accessible to the authenticated user (owner, collaborator, or viewer with appropriate permissions).
string
required
Semantic version number of the Pack version to retrieve source code for. Must follow semantic versioning format (e.g., ‘1.0.0’, ‘2.3.5’, ‘0.1.0’). Use CODA_LIST_THE_VERSIONS_FOR_A_PACK to get available versions for a Pack. Note that source code is only available for versions where it was explicitly uploaded during the Pack version creation process.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_GET_USER_INFOReturns basic info about the current user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_AVAILABLE_DOCSReturns a list of Coda docs accessible by the user, and which they have opened at least once. These are returned in the same order as on the docs page: reverse chronological by the latest event relevant to the user (last viewed, edited, or shared).

Input Parameters

integer
Maximum number of results to return in this query.
string
Search term used to filter down results.
boolean
Show only docs owned by the user.
string
Show only docs belonging to the given folder.
Show only docs visible within the gallery.
boolean
If true, returns docs that are starred. If false, returns docs that are not starred.
string
An opaque token used to fetch the next page of results.
string
Show only docs copied from the specified doc ID.
boolean
Show only published docs.
string
Show only docs belonging to the given workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_CATEGORIES_FOR_PACKList all publishing categories associated with a specific Coda Pack. Categories help users discover packs by organizing them into topics like ‘Project Management’, ‘Marketing’, ‘Engineering’, etc.

Input Parameters

integer
required
The numeric ID of the Coda Pack to retrieve categories for. You can obtain pack IDs from the list_packs action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_COLUMNSReturns a list of columns in a table.

Input Parameters

string
required
ID of the doc.
integer
Maximum number of results to return in this query.
string
An opaque token used to fetch the next page of results.
boolean
If true, returns only visible columns for the table. This parameter only applies to base tables, and not views.
string
required
ID or name of the table. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_CONTROLSReturns a list of controls in a Coda doc.

Input Parameters

string
required
ID of the doc.
integer
Maximum number of results to return in this query.
string ("name")
Determines how to sort the given objects.
string
An opaque token used to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_CUSTOM_DOC_DOMAINSLists custom domains configured for a published Coda document, including their setup and connection status. The response may include a link or token for another page.

Input Parameters

string
required
ID of the doc. This is the unique identifier for the Coda document (e.g., ‘DUTh3qjMrM’). You can get this from creating a doc or listing available docs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_DOC_ANALYTICSReturns analytics data for accessible documents. Provides detailed metrics including views, sessions (desktop/mobile/other), copies, likes, and AI credits usage. Supports filtering by workspace, date range, publication status, and search query. Results can be aggregated daily or cumulatively and sorted by various document properties or metric values.

Input Parameters

integer
Maximum number of results to return in this query.
string
Search term to filter documents by name or title. Returns only documents matching this query string.
string ("daily" | "cumulative")
Time period granularity for metrics aggregation. ‘daily’ returns metrics per day (default), ‘cumulative’ returns aggregated metrics over the entire date range.
array
List of document IDs to filter analytics. Provide as an array of doc IDs (e.g., [‘docId1’, ‘docId2’]). If not specified, returns analytics for all accessible documents.
string ("date" | "docId" | "title" | "createdAt" | "publishedAt" | "likes" | "copies" | "views" | "sessionsDesktop" | "sessionsMobile" | "sessionsOther" | "totalSessions" | "aiCreditsChat" | "aiCreditsBlock" | "aiCreditsColumn" | "aiCreditsAssistant" | "aiCreditsReviewer" | "aiCredits")
Field to sort results by. Options include document properties (date, docId, title, createdAt, publishedAt) or metric values (likes, copies, views, sessions, aiCredits).
string ("ascending" | "descending")
Sort direction. ‘ascending’ for lowest to highest, ‘descending’ for highest to lowest. Use with orderBy parameter.
string
Pagination token for fetching subsequent pages. Use the ‘nextPageToken’ value from a previous response to retrieve the next set of results.
string
Start date for analytics data range in ISO 8601 format (YYYY-MM-DD). Returns metrics on or after this date. Example: ‘2025-01-01’.
string
End date for analytics data range in ISO 8601 format (YYYY-MM-DD). Returns metrics on or before this date. Example: ‘2025-12-31’.
boolean
Filter by publication status. Set to true to return only published documents, false for unpublished, or omit to include all.
string
Filter analytics to documents in a specific workspace. Provide the workspace ID (e.g., ‘ws-1234Abcd’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_FOLDERSTool to list folders accessible by the user. Returns a list of folders with their metadata including ID, name, workspace, and icon. Use when you need to discover available folders or find a specific folder by workspace.

Input Parameters

integer
Maximum number of results to return in this query. Default is 25.
boolean
If true, returns folders that are starred. If false, returns folders that are not starred. If not specified, returns all folders.
string
An opaque token used to fetch the next page of results.
string
Show only folders belonging to the given workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_FORMULASReturns a list of named formulas in a Coda doc.

Input Parameters

string
required
ID of the doc.
integer
Maximum number of results to return in this query.
string ("name")
Determines how to sort the given objects.
string
An opaque token used to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_MAKERS_FOR_PACKList makers for a given pack.

Input Parameters

integer
required
ID of a Pack

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_PACK_ANALYTICSLists analytics for Packs the user can edit, including installation counts and invocation metrics. Supports workspace and date filters, sorting, and pagination.

Input Parameters

integer
Maximum number of results to return per page. Defaults to 1000. Use with pageToken for pagination.
string
Search term used to filter pack analytics by pack name or other attributes.
string ("daily" | "cumulative")
Quantization period over which to view analytics. Options: ‘daily’ (default) for daily metrics, or ‘cumulative’ for cumulative totals.
string ("date" | "packId" | "name" | "createdAt" | "docInstalls" | "workspaceInstalls" | "numFormulaInvocations" | "numActionInvocations" | "numSyncInvocations" | "numMetadataInvocations" | "docsActivelyUsing" | "docsActivelyUsing7Day" | "docsActivelyUsing30Day" | "docsActivelyUsing90Day" | "docsActivelyUsingAllTime" | "workspacesActivelyUsing" | "workspacesActivelyUsing7Day" | "workspacesActivelyUsing30Day" | "workspacesActivelyUsing90Day" | "workspacesActivelyUsingAllTime" | "workspacesWithActiveSubscriptions" | "workspacesWithSuccessfulTrials" | "revenueUsd")
Field to sort the pack analytics by. Options include: ‘date’, ‘packId’, ‘name’, ‘createdAt’, ‘docInstalls’, ‘workspaceInstalls’, ‘numFormulaInvocations’, ‘numActionInvocations’, ‘numSyncInvocations’, and various activelyUsing metrics.
array
Which Pack IDs to fetch. Note: This parameter may not be supported by the Coda API and may result in a 400 error if used.
string ("ascending" | "descending")
Direction to sort results in. Options: ‘ascending’ or ‘descending’. Use with orderBy parameter.
string
An opaque token used to fetch the next page of results. Obtain this from the ‘nextPageToken’ field in a previous response.
string
Limit results to activity on or after this date (ISO 8601 format, e.g., ‘2024-01-01’).
string
Limit results to activity on or before this date (ISO 8601 format, e.g., ‘2024-12-31’).
boolean
Limit results to only published packs. Set to true to get only published packs, or false/unspecified to get all packs including published ones.
string
ID of the workspace to filter pack analytics by. Use this to get analytics only for packs in a specific workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_PACK_FORMULA_ANALYTICSReturns analytics data for Pack formulas.

Input Parameters

integer
Maximum number of results to return in this query.
string ("daily" | "cumulative")
Quantization period over which to view analytics. Defaults to daily.
integer
required
ID of the Pack for which to retrieve formula analytics. You must have edit access to the pack.
string ("date" | "formulaName" | "formulaType" | "formulaInvocations" | "medianLatencyMs" | "medianResponseSizeBytes" | "errors" | "docsActivelyUsing" | "docsActivelyUsing7Day" | "docsActivelyUsing30Day" | "docsActivelyUsing90Day" | "docsActivelyUsingAllTime" | "workspacesActivelyUsing" | "workspacesActivelyUsing7Day" | "workspacesActivelyUsing30Day" | "workspacesActivelyUsing90Day" | "workspacesActivelyUsingAllTime")
Field by which to sort the analytics results. Options include date, formulaName, formulaInvocations, medianLatencyMs, errors, docsActivelyUsing, and various time-based active usage metrics.
string ("ascending" | "descending")
Direction to sort results in. Use ‘ascending’ for lowest to highest, ‘descending’ for highest to lowest.
string
An opaque token used to fetch the next page of results.
string
Limit results to activity on or after this date. Use ISO 8601 date format (e.g., ‘2024-01-15’).
string
Limit results to activity on or before this date. Use ISO 8601 date format (e.g., ‘2024-12-31’).
array
A list of Pack formula names (case-sensitive) for which to retrieve analytics. If not specified, returns analytics for all formulas in the pack.
array
A list of Pack formula types corresponding to the packFormulaNames. If specified, this must have the same length as packFormulaNames.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_PACKSGet the list of accessible Packs.

Input Parameters

integer
Maximum number of results to return in this query.
string ("title" | "createdAt" | "updatedAt")
The sort order of the Packs returned.
string ("ascending" | "descending")
Direction to sort results in.
string
An opaque token used to fetch the next page of results.
string ("view" | "test" | "edit" | "admin")
Deprecated, use accessTypes instead. Filter to only return the Packs for which the current user has this access type
array
Filter to only return the Packs for which the current user has these access types.
string
Use only this workspace (not all of a user”s workspaces) to check for Packs shared via workspace ACL.
boolean
Only get Packs shared with users/workspaces, not publicly.
array
Filter to only Packs whose parent workspace is one of the given IDs.
boolean
Do not include Packs that are only shared with workspaces.
boolean
Do not include Packs that are only shared with the user individually.
boolean
Include Packs that only support Coda Brain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_PAGE_ANALYTICSReturns page-level analytics data for pages within a document. Shows metrics like views and sessions per page over time. Important: This endpoint requires the document to be in an Enterprise workspace. If the document is not in an Enterprise workspace, the API will return a 401 Unauthorized error with the message: “Page level analytics are only available for Enterprise and higher plans”.

Input Parameters

string
required
ID of the doc. Must be a doc in an Enterprise workspace.
integer
Maximum number of results to return in this query.
string
An opaque token used to fetch the next page of results.
string
Limit results to activity on or after this date (ISO 8601 format, e.g., ‘2024-01-15’).
string
Limit results to activity on or before this date (ISO 8601 format, e.g., ‘2024-01-31’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_PAGE_CONTENTTool to list page content. Returns the content of the specified page. Use when you need to retrieve the content elements from a Coda page.

Input Parameters

integer
Maximum number of content items to return in this query. Default is 50.
string
required
ID of the doc containing the page.
string
An opaque token used to fetch the next page of results.
string ("plainText")
Format for content output.
string
required
ID or name of the page. Names are discouraged because they’re easily prone to being changed by users. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected. Note: URI encoding is handled automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_PAGESReturns a list of pages in a Coda doc.

Input Parameters

string
required
ID of the doc.
integer
Maximum number of results to return in this query.
string
An opaque token used to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_PERMISSIONSReturns a list of permissions for this Coda doc.

Input Parameters

string
required
ID of the doc.
integer
Maximum number of results to return in this query.
string
An opaque token used to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_PERMISSIONS_FOR_A_PACKGet user, workspace, and/or global permissions for a given Pack.

Input Parameters

integer
required
ID of a Pack

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_TABLE_ROWSRetrieves rows from a specific table within a Coda document. This endpoint allows you to fetch data from your Coda tables programmatically, enabling integration with other systems or data analysis tools. Use this when you need to access the content of a table in your Coda document, such as for reporting, data synchronization, or building custom views of your data outside of Coda. The endpoint supports pagination for large tables and allows you to control the number of rows returned per request. It’s important to note that this endpoint only retrieves data and doesn’t modify the table contents.

Input Parameters

string
required
ID of the doc.
integer
Maximum number of results to return in this query.
string
Query used to filter returned rows, specified as <column_id_or_name>:<value>. If you”d like to use a column name instead of an ID, you must quote it (e.g., "My Column":123). Also note that value is a JSON value; if you”d like to use a string, you must surround it in quotes (e.g., "groceries").
string ("createdAt" | "natural" | "updatedAt")
Specifies the sort order of the rows returned. If left unspecified, rows are returned by creation time ascending. “UpdatedAt” sort ordering is the order of rows based upon when they were last updated. This does not include updates to calculated values. “Natural” sort ordering is the order that the rows appear in the table view in the application. This ordering is only meaningfully defined for rows that are visible (unfiltered). Because of this, using this sort order will imply visibleOnly=true, that is, to only return visible rows. If you pass sortBy=natural and visibleOnly=false explicitly, this will result in a Bad Request error as this condition cannot be satisfied.
string
An opaque token used to fetch the next page of results.
string
An opaque token returned from a previous call that can be used to return results that are relevant to the query since the call where the syncToken was generated.
string ("simple" | "simpleWithArrays" | "rich")
The format that cell values are returned as.
boolean
If true, returns only visible rows and columns for the table.
string
required
ID or name of the table. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it.
boolean
Use column names instead of column IDs in the returned output. This is generally discouraged as it is fragile. If columns are renamed, code using original names may throw errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_TABLESLists tables and views in a Coda document, with pagination and optional table-type filtering.

Input Parameters

string
required
ID of the doc.
integer
Maximum number of results to return in this query.
string ("name")
Determines how to sort the given objects.
string
An opaque token used to fetch the next page of results.
array
Comma-separated list of table types to include in results. If omitted, includes both tables and views.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_THE_PACK_LISTINGS_ACCESSIBLE_TO_A_USERGet listings of public Packs and Packs created by you.

Input Parameters

integer
Maximum number of results to return in this query.
string ("packId" | "name" | "packVersion" | "packVersionModifiedAt")
Specify a sort order for the returned Pack listings returned.
string ("packId" | "name" | "packVersion" | "packVersionModifiedAt")
Deprecated: use sortBy instead.
array
Which Pack IDs to fetch.
string ("ascending" | "descending")
Direction to sort results in.
string
An opaque token used to fetch the next page of results.
string ("workspace" | "doc")
Type of installation context for which Pack information is being requested.
string
Use only this workspace (not all of a user”s workspaces) to check for Packs shared via workspace ACL.
array
Pack access types.
boolean
Only get Packs shared with users/workspaces, not publicly.
array
Filter to only Packs whose parent workspace is one of the given IDs.
boolean
Do not include Packs that are only shared with workspaces.
boolean
Do not include Packs that are only shared with the user individually.
boolean
Include Packs that only support Coda Brain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_THE_RELEASES_FOR_A_PACKGet the list of releases of a Pack.

Input Parameters

integer
Maximum number of results to return in this query.
integer
required
ID of a Pack
string
An opaque token used to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_THE_VERSIONS_FOR_A_PACKGet the list of versions of a Pack.

Input Parameters

integer
Maximum number of results to return in this query.
integer
required
ID of a Pack
string
An opaque token used to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_USER_PACK_INVITATIONSTool to get pending Pack invitations for the authenticated user. Use when you need to retrieve invitations to collaborate on Packs.

Input Parameters

integer
Maximum number of results to return in this query. Default is 25.
string
An opaque token used to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_WORKSPACE_ROLESReturns a list of the counts of users over time by role for the workspace. Note: This endpoint requires a workspace that belongs to an organization (Enterprise feature). Workspaces not belonging to an organization will return a 400 error with message “Workspace does not belong to an organization.”

Input Parameters

string
required
ID of the workspace (must belong to an organization). Use CODA_GET_USER_INFO to get your workspace ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_LIST_WORKSPACE_USERSReturns a list of members in the given workspace. This list will be ordered with the requesting user first and then ordered by role. Note: This endpoint requires a workspace that belongs to an organization (Enterprise feature). Workspaces not belonging to an organization will return a 400 error with message “Workspace does not belong to an organization.”

Input Parameters

string
An opaque token used to fetch the next page of results.
string
required
ID of the workspace (must belong to an organization). Use CODA_GET_USER_INFO to get your workspace ID.
array
Show only the members that match the included roles. Multiple roles can be specified with a comma-delimited list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_PACK_ASSET_UPLOAD_COMPLETENotify Coda that the Pack asset upload to S3 is complete. This action is the final step in the Pack asset upload workflow: 1. Call upload_a_pack_asset to get a signed S3 URL and packAssetUploadedPathName 2. Upload your image file (logo/cover/example) directly to the S3 URL using HTTP PUT 3. Call this action to notify Coda that the upload is complete and register the asset The packAssetId must be extracted from the packAssetUploadedPathName returned by upload_a_pack_asset. The packAssetType must match the type specified when initiating the upload. Supported asset types: - logo: Pack logo image (max 5MB, square recommended) - cover: Pack cover image (max 5MB, 1200x630px recommended) - exampleImage: Pack example/screenshot images (max 75MB) After completion, the asset will be processed and available for display in the Pack gallery and listing.

Input Parameters

integer
required
The unique ID of the Pack. This ID is returned when creating a Pack and identifies which Pack the asset belongs to.
string
required
The unique identifier for the Pack asset (a long hash string). This is the asset ID from the packAssetUploadedPathName returned by upload_a_pack_asset, extracted from the path: /packs/{packId}/assets/{packAssetId}/assetType/{packAssetType}/uploadComplete
string
required
The type of Pack asset being uploaded. Must be one of: ‘logo’ (Pack logo image), ‘cover’ (Pack cover image), or ‘exampleImage’ (Pack example/screenshot image). Must match the asset type specified when initiating the upload with upload_a_pack_asset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_PACK_SOURCE_CODE_UPLOAD_COMPLETENotify Coda that the Pack source code upload to S3 is complete. This action is the final step in the Pack source code upload workflow: 1. Call upload_pack_source_code to get a signed S3 URL 2. Upload your source code file to the S3 URL 3. Call this action to notify Coda that the upload is complete The filename and codeHash parameters must match the values used when initiating the upload with upload_pack_source_code.

Input Parameters

integer
required
The unique ID of the Pack. This ID is returned when creating a Pack and identifies which Pack the source code belongs to.
string
required
A SHA-256 hash of the source code file contents (64 hex characters). Used to verify file integrity and identify duplicate uploads. Must exactly match the hash provided when initiating the upload with upload_pack_source_code.
string
required
The filename of the source code file that was uploaded to S3. Must exactly match the filename provided when initiating the upload with upload_pack_source_code.
string
required
The semantic version string for this Pack version (e.g., ‘1.0.0’, ‘2.1.3-beta’). Must match the version used when initiating the upload with upload_pack_source_code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_PACK_VERSION_UPLOAD_COMPLETEMark a Pack version upload as complete to finalize the Pack version creation. This action is part of a multi-step workflow for creating Pack versions: 1. First, register a new Pack version using the ‘Register pack version’ action, which returns a signed upload URL 2. Upload your Pack version bundle (JavaScript/TypeScript code) to the signed URL 3. Call this action to notify Coda that the upload is complete and trigger Pack version validation and creation After completion, the Pack version will be validated and available for testing or release. Note: This action will fail with a 400 error if no upload was found for the specified Pack and version.

Input Parameters

string
Developer notes describing changes, improvements, or fixes in this Pack version.
integer
required
ID of a Pack
string ("web" | "cli")
Source of the Pack version upload. ‘web’ indicates uploaded via Coda’s web interface, ‘cli’ indicates uploaded via the Coda CLI tool.
string
required
Semantic version of a Pack
boolean
Set to true to bypass Coda’s protection against SDK version regression when multiple makers build versions. Use with caution as downgrading SDK versions may introduce compatibility issues.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_PATCH_THE_SYSTEM_CONNECTION_CREDENTIALS_OF_THE_PACKPatch the system connection credentials of the Pack.

Input Parameters

integer
required
ID of a Pack
object
Credentials to be patched for the Pack’s system connection. Since this is a PATCH operation, only the provided fields will be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_PUBLISH_DOCUpdate publish settings for a doc.

Input Parameters

string ("view" | "play" | "edit")
Which interaction mode the published doc should use.
string
Slug for the published doc.
string
required
ID of the doc.
boolean
If true, new users may be required to sign in to view content within this document. You will receive Coda credit for each user who signs up via your doc.
boolean
If true, indicates that the doc is discoverable.
array
The names of categories to apply to the document.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_PUSH_A_BUTTONPushes a button on a row in a table. Authorization note: This action is available to API tokens that are authorized to write to the table. However, the underlying button can perform any action on the document, including writing to other tables and performing Pack actions.

Input Parameters

string
required
ID of the doc.
string
required
ID or name of the row. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it. If there are multiple rows with the same value in the identifying column, an arbitrary one will be selected.
string
required
ID or name of the table. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it.
string
required
ID or name of the column. Names are discouraged because they”re easily prone to being changed by users. If you”re using a name, be sure to URI-encode it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_REGISTER_PACK_VERSIONRegisters a new Pack version and obtains a signed upload URL. This is the first step in the Pack version upload workflow. It registers a new version with Coda and returns a pre-signed S3 URL along with required headers for uploading the Pack bundle file. Workflow: 1. Call this action with packId, packVersion (semantic version), and bundleHash (SHA-256) 2. Use the returned upload_url and headers to upload your Pack bundle JSON via PUT request 3. After upload completes, call pack_version_upload_complete to finalize the registration 4. Optionally create a release to make the version available to users Prerequisites: - A Pack must exist (create one with CODA_CREATE_PACK if needed) - The version number must be greater than any existing version for this Pack - You must have calculated the SHA-256 hash of your Pack bundle file Note: The version must follow semantic versioning (e.g., 1.0.0, 1.2.3, 2.0.0).

Input Parameters

integer
required
ID of the Pack to register a new version for. You can obtain this from creating a Pack (CODA_CREATE_PACK) or listing Packs (CODA_LIST_PACKS).
string
required
SHA-256 hash of the Pack bundle file to be uploaded. This is a 64-character hexadecimal string. The hash is used to verify the integrity of the uploaded file. Calculate this using SHA-256 on your Pack definition JSON file. Example: ‘e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855’.
string
required
Semantic version number for the Pack version being registered. Must follow semantic versioning format (e.g., ‘1.0.0’, ‘1.2.3’, ‘2.0.0’). Must be greater than any previously registered version for this Pack. Use patch version for bug fixes (e.g., 1.0.1), minor version for backwards-compatible features (e.g., 1.1.0), and major version for breaking changes (e.g., 2.0.0).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_RETRIEVE_THE_GROUPED_LOGS_OF_A_PACKRetrieve grouped execution logs for a Pack in a specific Coda document. This endpoint returns Pack invocation logs grouped by execution, showing timestamps, status (success/failed), and detailed log entries for debugging. Logs are sorted by timestamp (newest first by default) and can be filtered by time range or search query. Use this to debug Pack executions, track errors, and monitor Pack performance in a document.

Input Parameters

string
Search query using Lucene syntax to filter logs by content (e.g., ‘error’, ‘level:error’, ‘message:failed’).
string
required
ID of the Coda document where the Pack is used. Use CODA_LIST_AVAILABLE_DOCS to find available document IDs.
integer
Maximum number of grouped log invocations to return per page. Default is 25.
string ("asc" | "desc")
Sort order for logs by timestamp: ‘asc’ (oldest first) or ‘desc’ (newest first). Default is ‘desc’.
integer
required
Numeric ID of the Pack whose logs you want to retrieve. Use CODA_LIST_PACKS to find available pack IDs.
string
Opaque pagination token from a previous response’s nextPageToken field. Use to fetch the next page of results.
string
Return only logs after this timestamp (non-inclusive). Format: ISO 8601 (e.g., ‘2026-01-01T00:00:00.000Z’).
string
Return only logs before this timestamp (non-inclusive). Format: ISO 8601 (e.g., ‘2026-01-30T12:00:00.000Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_RETRIEVE_THE_INFORMATION_FOR_A_SPECIFIC_LOGRetrieves details for a specific Pack ingestion log using an organization, ingestion, log, and details key. A 404 produces found=False; other error statuses raise an error.

Input Parameters

string
required
The unique identifier of the specific log entry to retrieve.
integer
required
ID of a Pack
string
required
The key identifying which specific details to retrieve from the log entry. This parameter specifies the type of detailed information requested.
string
required
ID of the organization. This is an Enterprise-level identifier used with Coda Brain features.
string
required
ID of the root ingestion. This identifies a specific data ingestion process in Coda Brain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_RETRIEVE_THE_LOGS_OF_A_INGESTIONRetrieves Pack ingestion logs for debugging, with filtering and pagination. A 404 produces an empty result; other error statuses raise an error.

Input Parameters

string
Search query to filter logs. Follows Lucene syntax for complex queries (e.g., ‘error AND status:failed’).
integer
Maximum number of results to return in this query.
string ("asc" | "desc")
Sort order for logs by timestamp: ‘asc’ (ascending/oldest first) or ‘desc’ (descending/newest first). Default is ‘desc’.
integer
required
ID of a Pack
array
Only return logs of the given types.
string
An opaque token used to fetch the next page of results.
array
Only return logs matching provided request IDs.
string
Only return logs after the given time (non-inclusive). Format: ISO 8601 timestamp.
string
required
ID of the organization. This is an Enterprise-level identifier used with Coda Brain features.
string
Only return logs before the given time (non-inclusive). Format: ISO 8601 timestamp.
string
required
ID of the root ingestion. This identifies a specific data ingestion process in Coda Brain.
string
ID of the ingestion execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_RETRIEVE_THE_LOGS_OF_A_PACKRetrieve the execution logs of a Pack within a specific document for debugging purposes. Note: Logs are typically retained for approximately 2 weeks.

Input Parameters

string
A search query that follows Lucene syntax to filter log messages. Example: ‘error’ or ‘status:failed’.
string
required
ID of the Coda document where the Pack is installed and being used.
integer
Maximum number of results to return in this query.
string ("asc" | "desc")
Specifies if the logs will be returned in time desc (newest first) or asc (oldest first). Default is desc.
integer
required
Numeric ID of the Pack whose logs you want to retrieve.
array
Only return logs of the given types.
string
An opaque token used to fetch the next page of results.
array
Only return logs matching provided request IDs.
string
Only return logs after the given time (non-inclusive). Format: ISO 8601 timestamp.
string
Only return logs before the given time (non-inclusive). Format: ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_RETRIEVE_THE_OAUTH_CONFIGURATION_OF_THE_PACKRetrieve the OAuth configuration of the Pack for display purpose. Secrets will be returned with masks.

Input Parameters

integer
required
ID of a Pack

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_RETRIEVE_THE_SYSTEM_CONNECTION_METADATA_OF_THE_PACKRetrieve the system connection metadata of a Pack. This endpoint returns metadata about a Pack’s system-level authentication configuration, where the Pack maker’s credentials are used for all users. Not all packs use system authentication - many use per-user authentication instead. Common error cases: - 400: Pack exists but hasn’t been uploaded with a version yet, or system authentication isn’t configured - 404: Pack doesn’t exist or doesn’t have system connection authentication

Input Parameters

integer
required
ID of the Pack to retrieve system connection metadata for. Must be a Pack you own or have appropriate access to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_SEARCH_PRINCIPALSSearch for users and groups (principals) that a Coda document can be shared with. This action searches across the workspace for principals matching the query term. The search is case-insensitive and matches against user names, email addresses, and group names. Results are limited to 20 users and 20 groups maximum. Use this action when you need to find people or groups to share a document with, or when building permission management workflows. Note: If no query is provided or the query is empty/whitespace-only, no results will be returned.

Input Parameters

string
required
The ID of the Coda document to search principals for. Must be a valid document ID that the authenticated user has access to.
string
Search term to find users and groups. Can match names, email addresses, or parts thereof. Case-insensitive. Leading/trailing whitespace is automatically trimmed. If empty or None, no results are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_SET_THE_OAUTH_CONFIGURATIONS_OF_THE_PACKSet OAuth2 client credentials (client ID, secret, redirect URI) for a Pack. Prerequisites: The Pack must have OAuth2 authentication defined in its source code using setUserAuthentication() with authorizationUrl and tokenUrl. You must obtain these credentials by registering your application with the OAuth provider (e.g., Google, GitHub, Salesforce). Note: This sets the credentials for an OAuth-enabled Pack, not the OAuth configuration itself (authorizationUrl, tokenUrl, scopes), which are defined in the Pack’s source code. Returns a request ID for tracking the configuration status. Changes may take a few moments to propagate.

Input Parameters

integer
required
ID of a Pack
string
The OAuth2 client ID for this Pack. This ID is obtained when you register your application with the OAuth provider’s developer portal. It identifies your Pack to the OAuth provider during the authorization flow.
string
The OAuth2 redirect URI (callback URL) for this Pack. This is the URL where users will be redirected after authorizing your Pack. For Coda Packs, this is typically a Coda-provided URL. The redirect URI must match exactly what you configured in the OAuth provider’s application settings.
string
The OAuth2 client secret for this Pack. This secret is obtained alongside the client ID when registering your application with the OAuth provider. It is used to securely authenticate token exchange requests. Keep this value confidential as it grants access to your Pack’s OAuth credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_SET_THE_SYSTEM_CONNECTION_CREDENTIALS_OF_THE_PACKSet the system connection credentials of the Pack. This endpoint completely replaces the existing system connection credentials for a Pack. System connection credentials are used when a Pack is configured with system-level authentication, where the Pack maker’s credentials are used for all users rather than per-user authentication. Prerequisites: - The Pack must have at least one version uploaded before credentials can be set - The Pack’s source code must define system authentication (e.g., via setSystemAuthentication()) - You must be the owner or have appropriate permissions for the Pack Note: This is a destructive operation that replaces all existing credentials. Use PATCH (/packs/{packId}/systemConnection) to update specific credential fields instead.

Input Parameters

integer
required
ID of a Pack. The Pack must have at least one version uploaded before system connection credentials can be set.
object
required
Credentials for the Pack’s system connection. The structure depends on the authentication type configured in the Pack’s source code (e.g., OAuth2ClientCredentials, HeaderBearerToken, WebBasic, CustomAuthentication, etc.). Common fields include ‘token’, ‘client_id’, ‘client_secret’, ‘username’, ‘password’, ‘api_key’, etc. This completely replaces any existing credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_TRIGGER_AUTOMATIONTriggers a webhook-invoked automation in a Coda doc. This action triggers an automation that has been configured with “Webhook invoked” as its trigger type. When triggered, the automation will execute its configured steps asynchronously. The response includes a requestId that can be used with the get_mutation_status action to check if the automation has completed. Important: The automation rule ID must be obtained manually from the Coda UI with Developer Mode enabled. There is currently no API endpoint to list automation rules programmatically.

Input Parameters

string
required
ID of the doc containing the webhook-triggered automation. Example: ‘AbCDeFGH’. You can get this from the list_available_docs action or from the doc’s browser URL.
string
required
ID of the webhook-triggered automation rule to trigger. To obtain this ID: 1) Enable Developer Mode in your Coda account settings (Labs > Enable Developer Mode), 2) Navigate to the automation in your doc, 3) Click the three-dots menu on the automation rule to view its ID. The automation must be configured as ‘Webhook invoked’ type. Example: ‘grid-auto-AbCdEfGh’.
object
Optional JSON payload to pass to the webhook automation. This data will be available in the automation’s steps as ‘Step 1 Result’. You can include any JSON-serializable data (strings, numbers, booleans, objects, arrays). Example: {‘message’: ‘Hello from API’, ‘count’: 42, ‘tags’: [‘urgent’, ‘test’]}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UNPUBLISH_DOCUnpublishes a Coda document, removing it from public access. This action removes the document from the Coda Gallery and makes it private to the workspace. The operation succeeds even if the document is already unpublished (idempotent). Note that this is a destructive operation that affects document visibility.

Input Parameters

string
required
ID of the doc to unpublish. This is the unique identifier for the Coda document (e.g., ‘pXsafDTyh1’). The document must exist and be accessible by the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPDATE_ACL_SETTINGSUpdate access control list (ACL) settings for a Coda document. This action allows you to control sharing and permission settings: - Whether editors can manage document permissions - Whether viewers can copy the document - Whether viewers can request editing access You can update one or multiple settings in a single request. Settings not specified in the request will retain their current values. Returns the complete set of ACL settings after the update.

Input Parameters

string
required
The ID of the Coda document whose ACL settings should be updated. Example: ‘AbCDeFGH’
boolean
Controls whether viewers can make copies of the document. When true, anyone with view access can create their own copy. When false, copying is restricted. Leave unset to keep current value.
boolean
Controls whether viewers can request edit access to the document. When true, viewers see a button to request editing permissions from the owner. When false, viewers cannot request access upgrades. Leave unset to keep current value.
boolean
Controls whether editors can modify document permissions. When true, editors can invite others and change sharing settings. When false, only the document owner can change permissions. Leave unset to keep current value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPDATE_AN_EXISTING_PACK_RELEASEUpdate the release notes of an existing Pack release. Use this to modify the description and changelog information displayed to users who have installed or are considering installing your Pack.

Input Parameters

integer
required
The ID of the Pack to update the release for.
string
Updated release notes describing key features, changes, or fixes in this release. Use this to communicate important information to Pack users.
integer
required
The ID of the Pack release to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPDATE_A_PAGEUpdate a page’s properties or append HTML or Markdown content. Updating a page title or icon requires you to be a Doc Maker in the applicable workspace.

Input Parameters

string
New name for the page. Note: Updating the page name requires Doc Maker permissions.
string
required
ID of the doc containing the page to update.
string
Name of the icon to use for the page. Can be a standard Coda icon name (e.g., ‘rocket’, ‘star’) or a custom icon reference. Requires Doc Maker permissions.
string
URL of the cover image to use for the page.
boolean
Whether the page should be hidden. Note: Some pages cannot be hidden (e.g., the sole top-level page in a doc), and this setting will be ignored for those pages.
string
New subtitle for the page.
string
required
ID or name of the page to update. Page IDs are recommended over names as names can be easily changed by users. If using a name, URI-encode it. If multiple pages have the same name, an arbitrary one will be selected.
object
Content update configuration for appending or inserting content into a page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPDATE_DOCUpdates metadata for a Coda document, including its title and icon. This action allows you to modify: - Document title/name - Document icon Note: Updating a doc title requires you to be a Doc Maker in the applicable workspace. The API returns an empty response on success - use CODA_GET_INFO_ABOUT_A_DOC to verify changes.

Input Parameters

string
required
The unique identifier of the document to update. You can obtain this from the CODA_LIST_AVAILABLE_DOCS or CODA_CREATE_DOC actions.
string
The new title/name for the document. If not provided, the document title remains unchanged.
string
The name of the icon to display for the document. Common icon names include: ‘rocket’, ‘star’, ‘lightbulb’, ‘calendar’, ‘coda’, etc. If not provided, the document icon remains unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPDATE_FOLDERTool to update folder metadata in Coda. Use when you need to modify the name or description of an existing folder. Note that some folder types (like personal folders) cannot be edited.

Input Parameters

string
Name of the folder.
string
required
ID of the folder to update.
string
Description of the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPDATE_PACKUpdate an existing Pack for non-versioned fields.

Input Parameters

string
The name of the Pack.
integer
required
ID of a Pack
string
The full description of the Pack.
string
The asset id of the Pack”s logo, returned by #PackAssetUploadComplete endpoint.
string
The asset id of the Pack”s cover image, returned by #PackAssetUploadComplete endpoint.
string
A contact email for the Pack.
array
The example images for the Pack.
string
A Privacy Policy URL for the Pack.
string
A short version of the description of the Pack.
string
A Terms of Service URL for the Pack.
string ("private" | "shared")
Visibility of a pack”s source code.
integer
The rate limit interval in seconds.
integer
The maximum number of Pack operations that can be performed in a given interval.
integer
The rate limit interval in seconds.
integer
The maximum number of Pack operations that can be performed in a given interval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPDATE_ROWDEPRECATED: Use CODA_UPSERT_ROWS instead. Tool to update an existing row in a Coda table. Use when you need to modify specific cell values in a row. This endpoint returns a 202 status code indicating the update has been queued and will be processed within seconds.

Input Parameters

object
required
Row object containing the cells to update.
string
required
ID of the doc containing the table.
string
required
ID or name of the row to update. Using row IDs is recommended. If using a name and multiple rows have the same value in the identifying column, an arbitrary one will be selected.
boolean
If true, the API will not attempt to parse the data in any way.
string
required
ID or name of the table. Using table IDs is recommended to avoid issues if table names change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPDATES_A_CUSTOM_DOMAINRequests an update to a published document’s custom domain, identified by document ID and domain. The action does not accept properties to update.

Input Parameters

string
required
ID of the doc.
string
required
A custom domain for a published doc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPDATES_USER_ROLEUpdates the workspace user role of a user that matches the parameters. Only succeeds if the requesting user has admin permissions in the workspace. Requirements: - The workspace must belong to an organization (Enterprise feature) - The requesting user must have Admin permissions in the workspace - The target user must already be a member of the workspace Note: This endpoint will return a 400 error with message “Workspace does not belong to an organization” if used with a non-Enterprise workspace.

Input Parameters

string
required
Email address of the user whose role you want to update.
string ("Admin" | "DocMaker" | "Editor")
required
The new workspace role to assign to the user. Must be one of: ‘Admin’ (full workspace admin access), ‘DocMaker’ (can create and edit docs), or ‘Editor’ (can edit but not create docs).
string
required
ID of the workspace (must belong to an organization). Use CODA_GET_USER_INFO to get your workspace ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPLOAD_A_PACK_ASSETRequest a signed s3 URL to upload your Pack asset.

Input Parameters

integer
required
ID of a Pack
string
required
Filename
string
required
The media type of the image being sent.
string
required
The SHA-256 hash of the image to be uploaded.
string ("logo" | "cover" | "exampleImage")
required
Packassettype

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPLOAD_PACK_SOURCE_CODERequest a signed s3 URL to upload your Pack source code.

Input Parameters

integer
required
ID of a Pack
string
required
Filename
string
Packversion
string
required
The SHA-256 hash of the image to be uploaded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODA_UPSERT_ROWSInsert or upsert rows in a Coda table using optional key columns, or update a specific row by ID or name. When a specific row is supplied, only the first submitted row is used and key columns are ignored.

Input Parameters

array
required
Array of row objects to insert or upsert. When row_id_or_name is provided, only the first row in the array is used.
string
required
ID of the doc containing the table.
array
Optional array of column IDs/names to use as upsert keys. If provided, existing rows matching these keys will be updated. Ignored when row_id_or_name is provided.
string
ID or name of a specific row to update. When provided, only the first item in ‘rows’ is used and a PUT request is made to update that specific row. Using row IDs is recommended to avoid issues if row names change.
boolean
If true, the API will not attempt to parse the data in any way.
string
required
ID or name of the table. Using table IDs is recommended to avoid issues if table names change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: CODA_DOCUMENT_DELETEDType: pollTriggers when a Coda document is deleted.

Configuration

string
Show only docs belonging to the given folder.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
boolean
Show only docs owned by the user.
boolean
Show only published docs.
boolean
If true, returns docs that are starred. If false, returns docs that are not starred.
integer
Maximum number of items to retrieve in a single poll (1-100).
string
Show only docs belonging to the given workspace.

Payload

object
required
The document that was deleted
string
required
Type of event
Slug: CODA_NEW_CODA_DOCUMENTType: pollTriggers when a new Coda document is created.

Configuration

string
Show only docs belonging to the given folder.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
boolean
Show only docs owned by the user.
boolean
Show only published docs.
boolean
If true, returns docs that are starred. If false, returns docs that are not starred.
integer
Maximum number of items to retrieve in a single poll (1-100).
string
Show only docs belonging to the given workspace.

Payload

The browser link to the document
string
The creation timestamp of the document
string
The ID of the folder containing the document
string
The URL of the document
string
The ID of the document
string
The name of the document
string
The email of the document owner
string
The name of the document owner
string
The type of the document
string
The last update timestamp of the document
string
The ID of the workspace containing the document
Slug: CODA_NEW_CODA_PAGEType: pollTriggers when a new page is added to a Coda document.

Configuration

string
required
ID of the Coda document to monitor for new pages.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
integer
Maximum number of pages to retrieve in a single poll (1-100).

Payload

string
required
Type of event
object
required
The page that triggered the event
Slug: CODA_SPECIFIC_CODA_PAGE_UPDATEDType: pollTriggers when a specific page within a Coda document is updated.

Configuration

string
required
ID of the Coda document containing the page to monitor.
number
Periodic Interval to Check for Updates & Send a Trigger in Minutes
string
required
ID or name of the specific page to monitor for updates.

Payload

string
required
Type of event
object
required
The page that was updated