Coda

Returns details about a specific table or view.

Returns settings associated with ACLs for this Coda doc.

Returns days based on Pacific Standard Time when analytics were last updated.

Get 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).

Returns aggregated analytics summary data across documents, including session counts, installs, copies, reads, and conversions. Can be filtered by publication status, date range, and workspace.

Retrieves the list of all available doc categories in Coda. These categories can be used when publishing docs to help users discover content.

Tool 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.

Retrieves 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.

Checks 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

Returns 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.

Retrieves detailed information about a specific Coda Pack by its ID. Returns pack metadata including name, description, workspace, logo URL, categories, rate limits, and configuration settings. Only accessible for Packs that the authenticated user has created or has been granted access to.

Returns metadata associated with sharing for this Coda doc.

Gets 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.

Get 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.

Retrieves 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.

Returns basic info about the current user.

Identifies 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.

Retrieves 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.

Returns 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).

List 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.

Returns a list of columns in a table.

Returns a list of controls in a Coda doc.

List all custom domains configured for a published Coda doc. Custom domains allow you to publish your doc at your own domain (e.g., www.example.com) instead of the default Coda.io URL. Returns an empty list if no custom domains are configured.

Returns 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.

Returns a list of featured docs for a Pack. Featured docs are example or template documents that showcase how to use the Pack. Each entry includes the document reference (id, type, href, browserLink), whether it's pinned at the top, and its published URL if available.

Tool 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.

Returns a list of named formulas in a Coda doc.

List makers for a given pack.

Returns analytics data for Packs the user can edit. This endpoint retrieves analytics information for Packs where the authenticated user has edit permissions. Analytics include installation counts, invocation metrics, and active usage statistics. All parameters are optional - if no filters are specified, returns analytics for all accessible Packs. Common use cases: - Get analytics for all accessible packs (no parameters) - Filter by workspace using workspaceId - Filter by date range using sinceDate/untilDate - Sort results using orderBy and direction - Paginate through results using limit and pageToken

Returns analytics data for Pack formulas.

Get the list of accessible Packs.

Returns 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".

Tool to list page content. Returns the content of the specified page. Use when you need to retrieve the content elements from a Coda page.

Returns a list of pages in a Coda doc.

Returns a list of permissions for this Coda doc.

Get user, workspace, and/or global permissions for a given Pack.

Retrieves 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.

Returns a list of tables in a Coda doc.

Get the list of releases of a Pack.

Get the list of versions of a Pack.

Tool to get pending Pack invitations for the authenticated user. Use when you need to retrieve invitations to collaborate on Packs.

Returns 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."

Returns 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."

Given a browser link to a Coda object, attempts to find it and return metadata that can be used to get more info on it. Returns a 400 if the URL does not appear to be a Coda URL or a 404 if the resource cannot be located with the current credentials.

Retrieve 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.

Retrieve detailed information for a specific log entry from a Pack ingestion. This action retrieves comprehensive log details for Coda Brain (Enterprise feature) ingestion debugging. It provides in-depth information about specific log entries including user context, action details, entity information, event metadata, and execution results. The action is useful for: - Investigating specific ingestion events or errors - Auditing user actions within Pack ingestion processes - Debugging failed or unexpected ingestion behaviors - Understanding the context of specific log entries Note: This endpoint requires valid organizationId, rootIngestionId, and logId values which are only available for Enterprise accounts with Coda Brain enabled. For non-existent or invalid IDs, the action returns a response with found=False.

Retrieve the logs of a Ingestion for debugging purpose. This action is typically used with Coda Brain (Enterprise feature) to track and debug data ingestion processes from external sources via Packs. Note: This endpoint requires valid organizationId and rootIngestionId values which are only available for Enterprise accounts with Coda Brain enabled. For non-existent or invalid IDs, the action returns an empty result.

Retrieve the execution logs of a Pack within a specific document for debugging purposes. Note: Logs are typically retained for approximately 2 weeks.

Retrieve the OAuth configuration of the Pack for display purpose. Secrets will be returned with masks.

Retrieve 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

Search 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.

Mark 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.

Registers 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).

Request a signed s3 URL to upload your Pack asset.

Update 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.

Update 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.

Updates 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.

Create or replace the featured docs for a Pack. Featured docs are example or template documents that showcase how to use the Pack. This action replaces the entire list of featured docs (it does not append). Requirements: - You must be the pack owner to update featured docs - Exactly one doc in the items list must have isPinned=true - All doc URLs must be published doc URLs (e.g., https://coda.io/@username/doc-name) - Regular browser links will cause a 400 error On success, returns an empty JSON object {}.

Tool 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.

Update an existing Pack for non-versioned fields.

Updates properties of a document's custom domain.

Updates 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.

Request a signed s3 URL to upload your Pack source code.

Deletes 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.

Deletes 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.

Deletes a custom domain from a published doc.

Pushes 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.

Set 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.

Unpublishes 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.