Skip to content
Try for free
On this page

Integrations

Coda

Read and write Coda docs, pages, tables, and rows

Coda (now Superhuman Docs) combines documents, tables, and automations in one doc. The Coda block lets your agents read and write that doc: create and publish docs, write pages in Markdown or HTML, read and update table rows, push row buttons, read formulas and controls, trigger automations, and manage sharing, folders, and analytics.

Authentication

This integration uses a reusable Coda API token connection, not OAuth. In Coda, open Account settings → API settings and generate a token. A token can be unrestricted, or limited to specific docs or tables with read or read-and-write access; a restricted token can only reach what it was granted. Create a Coda connection from the block's Coda Account field. Sim checks the token once against Coda, stores it encrypted, and reuses the same connection across Coda blocks. You can replace or revoke it from credential settings.

Working with Coda data

  • Pickers: After you pick an account, the Doc, Page, Table, Row, Column, Formula, Control, Folder, and Permission fields list what that token can reach. Switch a field to advanced mode to enter an ID, or pass one from an earlier block. IDs are safer than names, because users can rename things in the doc.
  • Links to IDs: Resolve Browser Link turns a Coda URL someone pasted into the resource type and ID the other operations need.
  • Changes apply in the background: Row, page, publishing, and automation writes return a requestId right away and are applied a few seconds later. Check that a change finished with Get Mutation Status. Data you read can also lag a few seconds behind edits made in the browser.
  • Rows: Pass rows as objects that map column IDs or names to values, for example [{"Name": "Apple", "Price": 1.25}]. Set Upsert Key Columns to update matching rows instead of adding duplicates. Inserts only work on base tables, not views. Turn on Use Column Names when reading rows to get values keyed by column name.
  • Incremental reads: List Rows returns a nextSyncToken. Pass it back later as Sync Token to get only rows that changed since then.
  • Pagination: List operations return a nextPageToken. Pass it as Page Token to get the next page. When a Page Token is set, the original filters and limit are reused automatically. Coda can change page sizes at any time, so keep paging until no token comes back.
  • Page content: Get Page Content reads a page as plain-text lines, with element IDs you can target in Update Page or Delete Page Content. To delete content, enter element IDs, or turn on Delete All Page Content to clear the whole page. For the full page as Markdown or HTML, run Export Page, then call Get Page Export Status until downloadLink is present. The link expires shortly after it is issued.
  • Permissions and plans: Creating docs and pages or renaming a doc requires Doc Maker access in the workspace. Publishing needs a Coda maker profile. Hiding pages and custom domains need a paid Coda plan. Workspace members, role activity, and role changes need a workspace that belongs to an organization, and role changes need Admin access. Page analytics are only available for docs in Enterprise workspaces.
  • Rate limits: Coda limits requests per user, with tighter limits on writes and on listing docs. Sim automatically retries reads, updates, and deletes when Coda returns HTTP 429 or a transient server error. Inserts and creates are not retried, so space out bulk writes.

Use the block

Use a reusable API-token credential to create, copy, publish, and share docs; create, update, read, export, and clear pages; read table schemas; list, insert, upsert, update, and delete rows and push row buttons; read formulas and controls; trigger webhook automations; manage folders, custom domains, and workspace roles; and read doc and page analytics. Pick docs, pages, tables, rows, and more from dropdowns populated by your account.

Actions

Coda Add Custom Domain

Connect a custom domain to a published Coda doc. Requires a Coda plan with custom domains.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
customDocDomainstringYesThe custom domain (e.g., "docs.example.com")

Output

ParameterTypeDescription
docIdstringID of the doc
customDocDomainstringThe custom domain that was added

Coda Share Doc

Share a Coda doc with a user, group, domain, workspace, or anyone with the link. Sharing with an email sends a notification unless suppressed.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
accessstringYesAccess level to grant: "readonly", "comment", or "write"
principalTypestringYesWho to share with: "email", "group", "domain", "workspace", or "anyone"
principalstringNoEmail address, group ID, domain, or workspace ID matching principalType. Not used for "anyone".
suppressEmailbooleanNoDo not send a sharing notification email

Output

ParameterTypeDescription
docIdstringID of the shared doc
accessstringAccess level granted
principalTypestringType of principal the doc was shared with

Coda Change User Role

Change the workspace role of a Coda user. Requires Admin access in a workspace that belongs to an organization.

Inputs and outputs

Input

ParameterTypeRequiredDescription
workspaceIdstringYesID of the workspace (e.g., "ws-1Ab234")
emailstringYesEmail address of the workspace member
newRolestringYesNew role: "Admin", "DocMaker", or "Editor"

Output

ParameterTypeDescription
emailstringEmail address of the member
newRolestringRole assigned
roleChangedAtstringWhen the role change took effect

Coda Create Doc

Create a Coda doc, optionally copying an existing doc and setting up its first page with Markdown, HTML, an embed, or a sync page. Requires Doc Maker access in the workspace.

Inputs and outputs

Input

ParameterTypeRequiredDescription
titlestringNoTitle of the new doc (defaults to "Untitled")
sourceDocstringNoID of an existing doc to copy
timezonestringNoTimezone for the new doc (e.g., "America/Los_Angeles")
folderIdstringNoID of the folder to create the doc in (defaults to "My docs")
pageNamestringNoName of the initial page
pageSubtitlestringNoSubtitle of the initial page
iconNamestringNoIcon name for the initial page (e.g., "rocket")
imageUrlstringNoCover image URL for the initial page
pageTypestringNoInitial page content type: "canvas" (default), "embed", or "syncPage"
contentFormatstringNoCanvas content format: "markdown" (default) or "html"
contentstringNoCanvas content for the initial page in the chosen format
embedUrlstringNoURL to embed as a full page (pageType "embed")
renderMethodstringNoEmbed render method: "standard" or "compatibility"
sourceDocIdstringNoDoc to sync from (pageType "syncPage")
sourcePageIdstringNoPage to sync (pageType "syncPage" with syncMode "page")
syncModestringNoSync page mode: "page" (default) or "document"
includeSubpagesbooleanNoInclude subpages in a single-page sync page

Output

ParameterTypeDescription
docobjectThe created doc
requestIdstringCoda request ID for the doc creation

Coda Create Folder

Create a folder in a Coda workspace

Inputs and outputs

Input

ParameterTypeRequiredDescription
namestringYesName of the folder
workspaceIdstringYesID of the workspace (e.g., "ws-1Ab234")
descriptionstringNoDescription of the folder

Output

ParameterTypeDescription
folderobjectThe created folder

Coda Create Page

Create a page in a Coda doc, optionally as a subpage, with Markdown or HTML content, a full-page embed, or a sync page from another doc. The page is created asynchronously. Requires Doc Maker access.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
namestringNoName of the page
subtitlestringNoSubtitle of the page
iconNamestringNoName of the page icon (e.g., "rocket")
imageUrlstringNoURL of a cover image for the page
parentPageIdstringNoID of the parent page, to create this page as a subpage
pageTypestringNoPage content type: "canvas" (default), "embed", or "syncPage"
contentFormatstringNoCanvas content format: "markdown" (default) or "html"
contentstringNoCanvas page content in the chosen format
embedUrlstringNoURL to embed as a full page (pageType "embed")
renderMethodstringNoEmbed render method: "standard" or "compatibility"
sourceDocIdstringNoDoc to sync from (pageType "syncPage")
sourcePageIdstringNoPage to sync (pageType "syncPage" with syncMode "page")
syncModestringNoSync page mode: "page" (default) or "document"
includeSubpagesbooleanNoInclude subpages in a single-page sync page

Output

ParameterTypeDescription
pageIdstringID of the created page

Coda Delete Custom Domain

Remove a custom domain from a published Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
customDocDomainstringYesThe custom domain (e.g., "docs.example.com")

Output

ParameterTypeDescription
docIdstringID of the doc
customDocDomainstringThe custom domain that was removed

Coda Delete Doc

Delete a Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")

Output

ParameterTypeDescription
docIdstringID of the deleted doc

Coda Delete Folder

Delete an empty Coda folder (it must contain no docs)

Inputs and outputs

Input

ParameterTypeRequiredDescription
folderIdstringYesID of the folder (e.g., "fl-1Ab234")

Output

ParameterTypeDescription
folderIdstringID of the deleted folder

Coda Delete Page

Delete a page from a Coda doc. Applied asynchronously.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
pageIdstringYesID or name of the page (IDs are recommended, e.g., "canvas-IjkLmnO"; names containing "/" are not supported)

Output

ParameterTypeDescription
pageIdstringID of the deleted page

Coda Delete Page Content

Delete specific content elements from a Coda page, or all of its content when no element IDs are given. Applied asynchronously.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
pageIdstringYesID or name of the page (IDs are recommended, e.g., "canvas-IjkLmnO"; names containing "/" are not supported)
elementIdsjsonNoElement IDs to delete (from Get Page Content), as an array or comma-separated list
deleteAllbooleanNoSet to true, with no element IDs, to delete all content from the page

Output

ParameterTypeDescription
pageIdstringID of the page whose content was deleted

Coda Remove Permission

Revoke a sharing permission on a Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
permissionIdstringYesID of the permission to remove (from List Permissions)

Output

ParameterTypeDescription
docIdstringID of the doc
permissionIdstringID of the removed permission

Coda Delete Row

Delete a row from a Coda table or view. Applied asynchronously.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableIdstringYesID or name of the table or view (IDs are recommended, e.g., "grid-pqRst-U"; names containing "/" are not supported)
rowIdstringYesID or name of the row (IDs are recommended, e.g., "i-tuVwxYz"; names containing "/" are not supported)

Output

ParameterTypeDescription
rowIdstringID of the deleted row

Coda Delete Rows

Delete multiple rows from a Coda table or view by ID. Applied asynchronously.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableIdstringYesID or name of the table or view (IDs are recommended, e.g., "grid-pqRst-U"; names containing "/" are not supported)
rowIdsjsonYesRow IDs to delete, as an array or comma-separated list (e.g., ["i-bCdeFgh", "i-CdEfgHi"])

Output

ParameterTypeDescription
rowIdsarrayIDs of the rows queued for deletion

Coda Export Page

Start exporting a Coda page as HTML or Markdown. Poll Get Page Export Status with the returned export ID for the download link.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
pageIdstringYesID or name of the page (IDs are recommended, e.g., "canvas-IjkLmnO"; names containing "/" are not supported)
outputFormatstringYesExport format: "markdown" or "html"

Output

ParameterTypeDescription
exportIdstringID of the export request
statusstringExport status (inProgress, failed, complete)
hrefstringAPI link that reports the export status

Coda Get Sharing Settings

Get the sharing settings of a Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")

Output

ParameterTypeDescription
docsjsonDocs (id, name, href, browserLink, icon, owner, ownerName, createdAt, updatedAt, workspace, folder, sourceDoc, docSize, published)
docjsonDoc (id, name, href, browserLink, icon, owner, ownerName, createdAt, updatedAt, workspace {id, name, organizationId}, folder {id, name}, sourceDoc, docSize {totalRowCount, tableAndViewCount, baseTableCount, pageCount, overApiSizeLimit}, published {description, browserLink, discoverable, mode, categories})
docIdstringID of the affected doc
categoriesjsonDoc category names
requestIdstringRequest ID of a queued change, for Get Mutation Status
customDomainsjsonCustom domains (customDocDomain, hasCertificate, hasDnsDocId, setupStatus, domainStatus, lastVerifiedTimestamp)
customDocDomainstringCustom domain
providerstringDNS provider of a custom domain
permissionsjsonPermissions (id, access, principal {type, email, groupId, groupName, domain, workspaceId})
accessstringAccess level granted
principalTypestringType of principal the doc was shared with
permissionIdstringID of the removed permission
usersjsonMatching users (name, loginId, pictureLink)
groupsjsonMatching groups (groupId, groupName)
canSharebooleanWhether the user can share the doc
canShareWithWorkspacebooleanWhether the user can share with the workspace
canShareWithOrgbooleanWhether the user can share with the org
canCopybooleanWhether the user can copy the doc
allowEditorsToChangePermissionsbooleanWhether editors can change permissions
allowCopyingbooleanWhether viewers can copy the doc
allowViewersToRequestEditingbooleanWhether viewers can request editing
pagesjsonPages (id, name, subtitle, browserLink, contentType, isHidden, icon, image, parent, children, authors, createdAt, updatedAt)
pagejsonPage (id, name, subtitle, href, browserLink, contentType, isHidden, isEffectivelyHidden, icon, image, parent, children, authors, createdAt, createdBy, updatedAt, updatedBy)
pageIdstringID of the created, updated, or deleted page
itemsjsonPage content lines (id, type, style, format, content, lineLevel), or analytics items (doc or page plus daily metrics)
exportIdstringPage export ID
statusstringPage export status (inProgress, failed, complete)
hrefstringAPI link reporting the page export status
downloadLinkstringDownload link of a completed page export
exportErrorstringError message of a failed page export
tablesjsonTables and views (id, name, tableType, href, browserLink, parent)
tablejsonTable (id, name, tableType, browserLink, parent, parentTable, displayColumnId, rowCount, sorts, layout, filter, createdAt, updatedAt)
columnsjsonColumns (id, name, display, calculated, formula, defaultValue, format)
columnjsonColumn (id, name, display, calculated, formula, defaultValue, format, parentTable)
rowsjsonRows (id, name, index, browserLink, createdAt, updatedAt, values)
rowjsonRow (id, name, index, browserLink, createdAt, updatedAt, values, parentTable)
nextSyncTokenstringToken for reading only rows changed later
addedRowIdsjsonIDs of rows that will be added
rowIdstringID of the affected row
rowIdsjsonIDs of rows queued for deletion
columnIdstringID of the pushed button column
formulasjsonNamed formulas (id, name, href, parent)
formulajsonFormula (id, name, href, parent, value)
controlsjsonControls (id, name, href, parent)
controljsonControl (id, name, href, parent, controlType, value)
foldersjsonFolders (id, name, browserLink, description, icon, iconColor, createdAt, canEdit, workspace)
folderjsonFolder (id, name, browserLink, description, icon, iconColor, createdAt, canEdit, workspace)
folderIdstringID of the deleted folder
childrenjsonSubfolders (id, name, browserLink, visibility, workspace, ...)
membersjsonWorkspace members (email, name, role, registeredAt, roleChangedAt, lastActiveAt, ownedDocs, totalDocs, ...)
emailstringEmail of the member whose role changed
newRolestringRole assigned
roleChangedAtstringWhen the role change took effect
roleActivityjsonMonthly role counts (month, activeAdminCount, activeDocMakerCount, activeEditorCount, inactive counts)
totalSessionsnumberTotal sessions across matching docs
docAnalyticsLastUpdatedstringDate doc analytics last updated
packAnalyticsLastUpdatedstringDate Pack analytics last updated
packFormulaAnalyticsLastUpdatedstringDate Pack formula analytics last updated
browserLinkstringCanonical browser link of a resolved resource
resourcejsonResolved resource (type, id, name, href)
completedbooleanWhether a queued change was applied
warningstringWarning for a change that completed with caveats
namestringName of the token owner
loginIdstringEmail of the token owner
pictureLinkstringAvatar link of the token owner
scopedbooleanWhether the token is restricted
tokenNamestringName of the API token
workspacejsonDefault workspace of the token owner (id, name, organizationId, browserLink)
nextPageTokenstringToken for fetching the next page of results

Coda Get Analytics Last Updated

Get the dates (Pacific time) Coda analytics were last refreshed, to know how current analytics data is

Inputs and outputs

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
docAnalyticsLastUpdatedstringDate doc analytics last updated
packAnalyticsLastUpdatedstringDate Pack analytics last updated
packFormulaAnalyticsLastUpdatedstringDate Pack formula analytics last updated

Coda Get Column

Get details about a column in a Coda table, including its full format settings

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableIdstringYesID or name of the table or view (IDs are recommended, e.g., "grid-pqRst-U"; names containing "/" are not supported)
columnIdstringYesID or name of the column (IDs are recommended, e.g., "c-tuVwxYz")

Output

ParameterTypeDescription
columnobjectColumn details

Coda Get Control

Get the type and current value of a control in a Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
controlIdstringYesID or name of the control (IDs are recommended, e.g., "ctrl-cDefGhij")

Output

ParameterTypeDescription
controlobjectControl details

Coda Get Custom Domain Provider

Look up the DNS provider (GoDaddy, Namecheap, Hover, Network Solutions, Google Domains, or Other) of a custom domain

Inputs and outputs

Input

ParameterTypeRequiredDescription
customDocDomainstringYesThe custom domain (e.g., "docs.example.com")

Output

ParameterTypeDescription
customDocDomainstringThe custom domain
providerstringDNS provider of the domain

Coda Get Doc

Get metadata for a Coda doc, including its owner, workspace, folder, size, and publishing settings

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")

Output

ParameterTypeDescription
docobjectDoc metadata

Coda Get Doc Analytics Summary

Get the total number of sessions across the Coda docs the user can access

Inputs and outputs

Input

ParameterTypeRequiredDescription
isPublishedbooleanNoOnly include published docs
sinceDatestringNoOnly include activity on or after this date (YYYY-MM-DD)
untilDatestringNoOnly include activity on or before this date (YYYY-MM-DD)
workspaceIdstringNoOnly include docs in this workspace

Output

ParameterTypeDescription
totalSessionsnumberTotal sessions across all matching docs

Coda Get Folder

Get details about a Coda folder

Inputs and outputs

Input

ParameterTypeRequiredDescription
folderIdstringYesID of the folder (e.g., "fl-1Ab234")

Output

ParameterTypeDescription
folderobjectFolder details

Coda Get Formula

Get the current computed value of a named formula in a Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
formulaIdstringYesID or name of the formula (IDs are recommended, e.g., "f-fgHijkLm")

Output

ParameterTypeDescription
formulaobjectFormula details

Coda Get Mutation Status

Check whether a queued Coda change (row, page, publish, or automation request) has been applied. Status is kept for about a day.

Inputs and outputs

Input

ParameterTypeRequiredDescription
requestIdstringYesRequest ID returned by a Coda write operation

Output

ParameterTypeDescription
completedbooleanWhether the change has been applied
warningstringWarning if the change completed with caveats

Coda Get Page

Get metadata for a page in a Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
pageIdstringYesID or name of the page (IDs are recommended, e.g., "canvas-IjkLmnO"; names containing "/" are not supported)

Output

ParameterTypeDescription
pageobjectPage metadata

Coda Get Page Content

Read the content of a Coda canvas page as plain-text lines with their styles (headings, paragraphs, lists, quotes, code) and element IDs

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
pageIdstringYesID or name of the page (IDs are recommended, e.g., "canvas-IjkLmnO"; names containing "/" are not supported)
limitnumberNoMaximum number of content items to return (1-500, default 50)
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
itemsarrayContent elements on the page, in order
↳ idstringElement ID, usable with Update Page and Delete Page Content
↳ typestringElement type (line)
↳ stylestringLine style (paragraph, h1, h2, h3, bulletedList, numberedList, checkboxList, collapsibleList, blockQuote, pullQuote, code)
↳ formatstringContent format (plainText)
↳ contentstringElement text
↳ lineLevelnumberIndentation level for paragraphs, quotes, and list items

Coda Get Page Export Status

Check a Coda page export and get its download link once complete. Download links expire shortly after they are issued.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
pageIdstringYesID or name of the page (IDs are recommended, e.g., "canvas-IjkLmnO"; names containing "/" are not supported)
exportIdstringYesExport ID returned by Export Page

Output

ParameterTypeDescription
exportIdstringID of the export request
statusstringExport status (inProgress, failed, complete)
hrefstringAPI link that reports the export status
downloadLinkstringShort-lived download link for the exported file, once complete
exportErrorstringError message if the export failed

Coda Get Row

Get a single row from a Coda table, including all of its cell values

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableIdstringYesID or name of the table or view (IDs are recommended, e.g., "grid-pqRst-U"; names containing "/" are not supported)
rowIdstringYesID or name of the row (IDs are recommended, e.g., "i-tuVwxYz"; names containing "/" are not supported)
useColumnNamesbooleanNoKey cell values by column name instead of column ID
valueFormatstringNoCell value format: "simple" (default), "simpleWithArrays", or "rich"

Output

ParameterTypeDescription
rowobjectRow details and values

Coda Get Sharing Metadata

Check whether the connected user can share or copy a Coda doc, and whether they can share it with the workspace or organization

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")

Output

ParameterTypeDescription
canSharebooleanWhether the user can share the doc
canShareWithWorkspacebooleanWhether the user can share the doc with the workspace
canShareWithOrgbooleanWhether the user can share the doc with the organization
canCopybooleanWhether the user can copy the doc

Coda Get Table

Get details about a table or view in a Coda doc, including its row count, sorts, layout, and filter

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableIdstringYesID or name of the table or view (IDs are recommended, e.g., "grid-pqRst-U"; names containing "/" are not supported)
useUpdatedTableLayoutsbooleanNoReport detail and form layouts as "detail" and "form" instead of "masterDetail" for both

Output

ParameterTypeDescription
tableobjectTable details

Coda List Doc Categories

List the categories that can be applied to a published Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
categoriesarrayCategory names usable when publishing a doc

Coda List Columns

List the columns of a Coda table with their IDs, formats, and formulas. Use column IDs when reading and writing rows.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableIdstringYesID or name of the table or view (IDs are recommended, e.g., "grid-pqRst-U"; names containing "/" are not supported)
visibleOnlybooleanNoOnly return visible columns (applies to base tables, not views)
limitnumberNoMaximum number of columns to return (1-100, default 25)
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
columnsarrayColumns in the table

Coda List Controls

List the controls (sliders, selects, checkboxes, date pickers, buttons, etc.) in a Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
sortBystringNoSort order; "name" sorts alphabetically
limitnumberNoMaximum number of results to return per page
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
controlsarrayControls in the doc

Coda List Custom Domains

List the custom domains connected to a published Coda doc and their setup status

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")

Output

ParameterTypeDescription
customDomainsarrayCustom domains for the published doc
↳ customDocDomainstringThe custom domain
↳ hasCertificatebooleanWhether the domain has a certificate
↳ hasDnsDocIdbooleanWhether the domain DNS points back to this doc
↳ setupStatusstringSetup status (pending, succeeded, failed)
↳ domainStatusstringconnected or notConnected
↳ lastVerifiedTimestampstringWhen the DNS settings were last checked

Coda List Doc Analytics

Get per-day or cumulative analytics (views, copies, likes, sessions by device, AI credits) for Coda docs

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdsjsonNoDoc IDs to fetch analytics for, as an array or comma-separated list
workspaceIdstringNoOnly include docs in this workspace
querystringNoSearch term used to filter docs
isPublishedbooleanNoOnly include published docs
sinceDatestringNoOnly include activity on or after this date (YYYY-MM-DD)
untilDatestringNoOnly include activity on or before this date (YYYY-MM-DD)
scalestringNoAggregation: "daily" (default) or "cumulative"
orderBystringNoSort field: date, docId, title, createdAt, publishedAt, likes, copies, views, sessionsDesktop, sessionsMobile, sessionsOther, totalSessions, or an aiCredits field
directionstringNoSort direction: "ascending" or "descending"
limitnumberNoMaximum number of results to return (1-5000, default 1000)
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
itemsarrayAnalytics per doc
↳ docobjectDoc the metrics belong to
↳ metricsarrayMetrics per date
↳ datestringDate of the data (YYYY-MM-DD)
↳ viewsnumberDoc views
↳ copiesnumberDoc copies
↳ likesnumberDoc likes
↳ sessionsMobilenumberUnique mobile visitors
↳ sessionsDesktopnumberUnique desktop visitors
↳ sessionsOthernumberUnique visitors on other devices
↳ totalSessionsnumberSessions across all devices
↳ aiCreditsChatnumberAI credits used by chat
↳ aiCreditsBlocknumberAI credits used by AI blocks
↳ aiCreditsColumnnumberAI credits used by AI columns
↳ aiCreditsAssistantnumberAI credits used by the assistant
↳ aiCreditsReviewernumberAI credits used by the reviewer
↳ aiCreditsnumberTotal AI credits used

Coda List Docs

List Coda docs the user has opened, most recently used first, filtered by search, owner, publishing, stars, workspace, folder, or source doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
querystringNoSearch term used to filter docs
isOwnerbooleanNoOnly return docs owned by the user
isPublishedbooleanNoOnly return published docs
isStarredbooleanNotrue returns only starred docs; false returns only unstarred docs
inGallerybooleanNoOnly return docs visible in the gallery
sourceDocstringNoOnly return docs copied from this doc ID
workspaceIdstringNoOnly return docs in this workspace (e.g., "ws-1Ab234")
folderIdstringNoOnly return docs in this folder (e.g., "fl-1Ab234")
limitnumberNoMaximum number of results to return per page
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
docsarrayDocs matching the filters

Coda List Subfolders

List the direct subfolders of a Coda folder. Subfolders you cannot access but manage the parent of are returned with only an ID and restricted visibility.

Inputs and outputs

Input

ParameterTypeRequiredDescription
folderIdstringYesID of the folder (e.g., "fl-1Ab234")
limitnumberNoMaximum number of results to return per page
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
childrenarrayDirect subfolders
↳ visibilitystringvisible, or restricted when only the ID is returned because you cannot access the subfolder

Coda List Folders

List the Coda folders the user can access, optionally within one workspace

Inputs and outputs

Input

ParameterTypeRequiredDescription
workspaceIdstringNoOnly return folders in this workspace (e.g., "ws-1Ab234")
isStarredbooleanNotrue returns only starred folders; false returns only unstarred folders
limitnumberNoMaximum number of results to return per page
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
foldersarrayFolders the user can access

Coda List Formulas

List the named formulas in a Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
sortBystringNoSort order; "name" sorts alphabetically
limitnumberNoMaximum number of results to return per page
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
formulasarrayNamed formulas in the doc

Coda List Page Analytics

Get daily analytics (views, sessions, users, time viewed) for each page of a Coda doc. Only available for docs in Enterprise workspaces.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
sinceDatestringNoOnly include activity on or after this date (YYYY-MM-DD)
untilDatestringNoOnly include activity on or before this date (YYYY-MM-DD)
limitnumberNoMaximum number of results to return (1-5000, default 1000)
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
itemsarrayAnalytics per page
↳ pageobjectPage the metrics belong to
↳ metricsarrayMetrics per date
↳ datestringDate of the data (YYYY-MM-DD)
↳ viewsnumberPage views that day
↳ sessionsnumberUnique browsers that viewed the page
↳ usersnumberUnique Coda users that viewed the page
↳ averageSecondsViewednumberAverage seconds the page was viewed
↳ medianSecondsViewednumberMedian seconds the page was viewed
↳ tabsnumberUnique tabs that opened the doc

Coda List Pages

List the pages in a Coda doc, including their hierarchy

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
limitnumberNoMaximum number of results to return per page
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
pagesarrayPages in the doc

Coda List Permissions

List who a Coda doc is shared with and their access levels

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
limitnumberNoMaximum number of results to return per page
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
permissionsarrayPermissions granted on the doc

Coda List Rows

List rows in a Coda table or view, optionally filtered by a column value, sorted, or limited to rows changed since a sync token

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableIdstringYesID or name of the table or view (IDs are recommended, e.g., "grid-pqRst-U"; names containing "/" are not supported)
querystringNoFilter as <column_id_or_name>:<JSON value>. Quote column names and string values, e.g., c-tuVwxYz:"Apple" or "Status":"Done"
sortBystringNoSort order: "createdAt" (default), "updatedAt", or "natural" (view order; implies visibleOnly)
useColumnNamesbooleanNoKey cell values by column name instead of column ID
valueFormatstringNoCell value format: "simple" (default), "simpleWithArrays", or "rich"
visibleOnlybooleanNoOnly return visible rows and columns
syncTokenstringNonextSyncToken from a previous call, to return only rows changed since then
limitnumberNoMaximum number of results to return per page
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
rowsarrayRows in the table
nextSyncTokenstringToken to pass as syncToken later to fetch only rows changed after this call

Coda List Tables

List the tables and views in a Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableTypesjsonNoTable types to include, as an array or comma-separated list of "table", "view", "database" (defaults to all)
sortBystringNoSort order; "name" sorts alphabetically
limitnumberNoMaximum number of results to return per page
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
tablesarrayTables and views in the doc

Coda List Workspace Members

List the members of a Coda workspace with their roles and doc activity, requesting user first. The workspace must belong to an organization.

Inputs and outputs

Input

ParameterTypeRequiredDescription
workspaceIdstringYesID of the workspace (e.g., "ws-1Ab234")
includedRolesjsonNoOnly return members with these roles, as an array or comma-separated list of "Admin", "DocMaker", "Editor"
pageTokenstringNoPage token from a previous response to fetch the next page

Output

ParameterTypeDescription
membersarrayWorkspace members
↳ emailstringEmail address
↳ namestringName
↳ rolestringWorkspace role (Admin, DocMaker, Editor)
↳ pictureUrlstringAvatar link
↳ registeredAtstringWhen the user joined the workspace
↳ roleChangedAtstringWhen the role last changed
↳ lastActiveAtstringDate the user last acted in any workspace
↳ ownedDocsnumberDocs the user owns in this workspace
↳ docsLastActiveAtstringDate anyone last accessed a doc the user owns
↳ docCollaboratorCountnumberCollaborators on docs the user owns in the last 90 days
↳ totalDocsnumberDocs the user owns, manages, or added pages to in the last 90 days
↳ totalDocsLastActiveAtstringDate anyone last accessed a doc the user owns or contributed to
↳ totalDocCollaboratorsLast90DaysnumberUnique viewers of docs the user owns, manages, or added pages to

Coda List Workspace Role Activity

Get monthly counts of active and inactive Admins, Doc Makers, and Editors in a workspace. The workspace must belong to an organization.

Inputs and outputs

Input

ParameterTypeRequiredDescription
workspaceIdstringYesID of the workspace (e.g., "ws-1Ab234")

Output

ParameterTypeDescription
roleActivityarrayRole counts per month
↳ monthstringMonth of the data (YYYY-MM-DD)
↳ activeAdminCountnumberActive Admins
↳ activeDocMakerCountnumberActive Doc Makers
↳ activeEditorCountnumberActive Editors
↳ inactiveAdminCountnumberInactive Admins
↳ inactiveDocMakerCountnumberInactive Doc Makers
↳ inactiveEditorCountnumberInactive Editors

Coda Publish Doc

Publish a Coda doc or update its publishing settings: URL slug, discoverability, categories, and interaction mode. The doc owner needs a Coda maker profile.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
slugstringNoURL slug for the published doc (e.g., "my-doc")
discoverablebooleanNoWhether the published doc is discoverable in the gallery
categoryNamesjsonNoCategory names to apply, as an array or comma-separated list (see List Doc Categories)
modestringNoInteraction mode for viewers: "view", "play", or "edit"

Output

ParameterTypeDescription
docsjsonDocs (id, name, href, browserLink, icon, owner, ownerName, createdAt, updatedAt, workspace, folder, sourceDoc, docSize, published)
docjsonDoc (id, name, href, browserLink, icon, owner, ownerName, createdAt, updatedAt, workspace {id, name, organizationId}, folder {id, name}, sourceDoc, docSize {totalRowCount, tableAndViewCount, baseTableCount, pageCount, overApiSizeLimit}, published {description, browserLink, discoverable, mode, categories})
docIdstringID of the affected doc
categoriesjsonDoc category names
requestIdstringRequest ID of a queued change, for Get Mutation Status
customDomainsjsonCustom domains (customDocDomain, hasCertificate, hasDnsDocId, setupStatus, domainStatus, lastVerifiedTimestamp)
customDocDomainstringCustom domain
providerstringDNS provider of a custom domain
permissionsjsonPermissions (id, access, principal {type, email, groupId, groupName, domain, workspaceId})
accessstringAccess level granted
principalTypestringType of principal the doc was shared with
permissionIdstringID of the removed permission
usersjsonMatching users (name, loginId, pictureLink)
groupsjsonMatching groups (groupId, groupName)
canSharebooleanWhether the user can share the doc
canShareWithWorkspacebooleanWhether the user can share with the workspace
canShareWithOrgbooleanWhether the user can share with the org
canCopybooleanWhether the user can copy the doc
allowEditorsToChangePermissionsbooleanWhether editors can change permissions
allowCopyingbooleanWhether viewers can copy the doc
allowViewersToRequestEditingbooleanWhether viewers can request editing
pagesjsonPages (id, name, subtitle, browserLink, contentType, isHidden, icon, image, parent, children, authors, createdAt, updatedAt)
pagejsonPage (id, name, subtitle, href, browserLink, contentType, isHidden, isEffectivelyHidden, icon, image, parent, children, authors, createdAt, createdBy, updatedAt, updatedBy)
pageIdstringID of the created, updated, or deleted page
itemsjsonPage content lines (id, type, style, format, content, lineLevel), or analytics items (doc or page plus daily metrics)
exportIdstringPage export ID
statusstringPage export status (inProgress, failed, complete)
hrefstringAPI link reporting the page export status
downloadLinkstringDownload link of a completed page export
exportErrorstringError message of a failed page export
tablesjsonTables and views (id, name, tableType, href, browserLink, parent)
tablejsonTable (id, name, tableType, browserLink, parent, parentTable, displayColumnId, rowCount, sorts, layout, filter, createdAt, updatedAt)
columnsjsonColumns (id, name, display, calculated, formula, defaultValue, format)
columnjsonColumn (id, name, display, calculated, formula, defaultValue, format, parentTable)
rowsjsonRows (id, name, index, browserLink, createdAt, updatedAt, values)
rowjsonRow (id, name, index, browserLink, createdAt, updatedAt, values, parentTable)
nextSyncTokenstringToken for reading only rows changed later
addedRowIdsjsonIDs of rows that will be added
rowIdstringID of the affected row
rowIdsjsonIDs of rows queued for deletion
columnIdstringID of the pushed button column
formulasjsonNamed formulas (id, name, href, parent)
formulajsonFormula (id, name, href, parent, value)
controlsjsonControls (id, name, href, parent)
controljsonControl (id, name, href, parent, controlType, value)
foldersjsonFolders (id, name, browserLink, description, icon, iconColor, createdAt, canEdit, workspace)
folderjsonFolder (id, name, browserLink, description, icon, iconColor, createdAt, canEdit, workspace)
folderIdstringID of the deleted folder
childrenjsonSubfolders (id, name, browserLink, visibility, workspace, ...)
membersjsonWorkspace members (email, name, role, registeredAt, roleChangedAt, lastActiveAt, ownedDocs, totalDocs, ...)
emailstringEmail of the member whose role changed
newRolestringRole assigned
roleChangedAtstringWhen the role change took effect
roleActivityjsonMonthly role counts (month, activeAdminCount, activeDocMakerCount, activeEditorCount, inactive counts)
totalSessionsnumberTotal sessions across matching docs
docAnalyticsLastUpdatedstringDate doc analytics last updated
packAnalyticsLastUpdatedstringDate Pack analytics last updated
packFormulaAnalyticsLastUpdatedstringDate Pack formula analytics last updated
browserLinkstringCanonical browser link of a resolved resource
resourcejsonResolved resource (type, id, name, href)
completedbooleanWhether a queued change was applied
warningstringWarning for a change that completed with caveats
namestringName of the token owner
loginIdstringEmail of the token owner
pictureLinkstringAvatar link of the token owner
scopedbooleanWhether the token is restricted
tokenNamestringName of the API token
workspacejsonDefault workspace of the token owner (id, name, organizationId, browserLink)
nextPageTokenstringToken for fetching the next page of results

Coda Push Button

Push a button column on a row of a Coda table, running its action. The button can perform any action in the doc.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableIdstringYesID or name of the table or view (IDs are recommended, e.g., "grid-pqRst-U"; names containing "/" are not supported)
rowIdstringYesID or name of the row (IDs are recommended, e.g., "i-tuVwxYz"; names containing "/" are not supported)
columnIdstringYesID or name of the button column (e.g., "c-tuVwxYz")

Output

ParameterTypeDescription
rowIdstringID of the row containing the button
columnIdstringID of the button column

Coda Resolve Browser Link

Resolve a Coda browser URL (doc, page, table, row, etc.) into its resource type and ID for use in other Coda operations

Inputs and outputs

Input

ParameterTypeRequiredDescription
urlstringYesCoda browser link, e.g., https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO
degradeGracefullybooleanNoIf the linked object was deleted, resolve the nearest existing parent (up to the doc) instead of failing

Output

ParameterTypeDescription
browserLinkstringCanonical browser link to the resource
resourceobjectThe resolved resource
↳ typestringResource type (doc, page, table, row, column, formula, control, etc.)
↳ idstringResource ID
↳ namestringResource name
↳ hrefstringAPI link to the resource

Coda Search Principals

Search for users and groups a Coda doc can be shared with (up to 20 of each). Returns nothing without a query.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
querystringNoName or email to search for

Output

ParameterTypeDescription
usersarrayMatching users
↳ namestringUser name
↳ loginIdstringUser email address
↳ pictureLinkstringAvatar link
groupsarrayMatching groups
↳ groupIdstringGroup ID
↳ groupNamestringGroup name

Coda Trigger Automation

Trigger a webhook-invoked automation in a Coda doc, optionally passing a JSON payload the automation can read

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
ruleIdstringYesID of the automation rule (e.g., "grid-auto-b3Jmey6jBS")
payloadjsonNoJSON object passed to the automation

Output

ParameterTypeDescription
docsjsonDocs (id, name, href, browserLink, icon, owner, ownerName, createdAt, updatedAt, workspace, folder, sourceDoc, docSize, published)
docjsonDoc (id, name, href, browserLink, icon, owner, ownerName, createdAt, updatedAt, workspace {id, name, organizationId}, folder {id, name}, sourceDoc, docSize {totalRowCount, tableAndViewCount, baseTableCount, pageCount, overApiSizeLimit}, published {description, browserLink, discoverable, mode, categories})
docIdstringID of the affected doc
categoriesjsonDoc category names
requestIdstringRequest ID of a queued change, for Get Mutation Status
customDomainsjsonCustom domains (customDocDomain, hasCertificate, hasDnsDocId, setupStatus, domainStatus, lastVerifiedTimestamp)
customDocDomainstringCustom domain
providerstringDNS provider of a custom domain
permissionsjsonPermissions (id, access, principal {type, email, groupId, groupName, domain, workspaceId})
accessstringAccess level granted
principalTypestringType of principal the doc was shared with
permissionIdstringID of the removed permission
usersjsonMatching users (name, loginId, pictureLink)
groupsjsonMatching groups (groupId, groupName)
canSharebooleanWhether the user can share the doc
canShareWithWorkspacebooleanWhether the user can share with the workspace
canShareWithOrgbooleanWhether the user can share with the org
canCopybooleanWhether the user can copy the doc
allowEditorsToChangePermissionsbooleanWhether editors can change permissions
allowCopyingbooleanWhether viewers can copy the doc
allowViewersToRequestEditingbooleanWhether viewers can request editing
pagesjsonPages (id, name, subtitle, browserLink, contentType, isHidden, icon, image, parent, children, authors, createdAt, updatedAt)
pagejsonPage (id, name, subtitle, href, browserLink, contentType, isHidden, isEffectivelyHidden, icon, image, parent, children, authors, createdAt, createdBy, updatedAt, updatedBy)
pageIdstringID of the created, updated, or deleted page
itemsjsonPage content lines (id, type, style, format, content, lineLevel), or analytics items (doc or page plus daily metrics)
exportIdstringPage export ID
statusstringPage export status (inProgress, failed, complete)
hrefstringAPI link reporting the page export status
downloadLinkstringDownload link of a completed page export
exportErrorstringError message of a failed page export
tablesjsonTables and views (id, name, tableType, href, browserLink, parent)
tablejsonTable (id, name, tableType, browserLink, parent, parentTable, displayColumnId, rowCount, sorts, layout, filter, createdAt, updatedAt)
columnsjsonColumns (id, name, display, calculated, formula, defaultValue, format)
columnjsonColumn (id, name, display, calculated, formula, defaultValue, format, parentTable)
rowsjsonRows (id, name, index, browserLink, createdAt, updatedAt, values)
rowjsonRow (id, name, index, browserLink, createdAt, updatedAt, values, parentTable)
nextSyncTokenstringToken for reading only rows changed later
addedRowIdsjsonIDs of rows that will be added
rowIdstringID of the affected row
rowIdsjsonIDs of rows queued for deletion
columnIdstringID of the pushed button column
formulasjsonNamed formulas (id, name, href, parent)
formulajsonFormula (id, name, href, parent, value)
controlsjsonControls (id, name, href, parent)
controljsonControl (id, name, href, parent, controlType, value)
foldersjsonFolders (id, name, browserLink, description, icon, iconColor, createdAt, canEdit, workspace)
folderjsonFolder (id, name, browserLink, description, icon, iconColor, createdAt, canEdit, workspace)
folderIdstringID of the deleted folder
childrenjsonSubfolders (id, name, browserLink, visibility, workspace, ...)
membersjsonWorkspace members (email, name, role, registeredAt, roleChangedAt, lastActiveAt, ownedDocs, totalDocs, ...)
emailstringEmail of the member whose role changed
newRolestringRole assigned
roleChangedAtstringWhen the role change took effect
roleActivityjsonMonthly role counts (month, activeAdminCount, activeDocMakerCount, activeEditorCount, inactive counts)
totalSessionsnumberTotal sessions across matching docs
docAnalyticsLastUpdatedstringDate doc analytics last updated
packAnalyticsLastUpdatedstringDate Pack analytics last updated
packFormulaAnalyticsLastUpdatedstringDate Pack formula analytics last updated
browserLinkstringCanonical browser link of a resolved resource
resourcejsonResolved resource (type, id, name, href)
completedbooleanWhether a queued change was applied
warningstringWarning for a change that completed with caveats
namestringName of the token owner
loginIdstringEmail of the token owner
pictureLinkstringAvatar link of the token owner
scopedbooleanWhether the token is restricted
tokenNamestringName of the API token
workspacejsonDefault workspace of the token owner (id, name, organizationId, browserLink)
nextPageTokenstringToken for fetching the next page of results

Coda Unpublish Doc

Unpublish a Coda doc

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")

Output

ParameterTypeDescription
docIdstringID of the unpublished doc

Coda Update Sharing Settings

Update who can change permissions, copy, or request edit access on a Coda doc; unset settings are left unchanged

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
allowEditorsToChangePermissionsbooleanNoAllow editors to change doc permissions
allowCopyingbooleanNoAllow viewers to copy the doc
allowViewersToRequestEditingbooleanNoAllow viewers to request edit access

Output

ParameterTypeDescription
docsjsonDocs (id, name, href, browserLink, icon, owner, ownerName, createdAt, updatedAt, workspace, folder, sourceDoc, docSize, published)
docjsonDoc (id, name, href, browserLink, icon, owner, ownerName, createdAt, updatedAt, workspace {id, name, organizationId}, folder {id, name}, sourceDoc, docSize {totalRowCount, tableAndViewCount, baseTableCount, pageCount, overApiSizeLimit}, published {description, browserLink, discoverable, mode, categories})
docIdstringID of the affected doc
categoriesjsonDoc category names
requestIdstringRequest ID of a queued change, for Get Mutation Status
customDomainsjsonCustom domains (customDocDomain, hasCertificate, hasDnsDocId, setupStatus, domainStatus, lastVerifiedTimestamp)
customDocDomainstringCustom domain
providerstringDNS provider of a custom domain
permissionsjsonPermissions (id, access, principal {type, email, groupId, groupName, domain, workspaceId})
accessstringAccess level granted
principalTypestringType of principal the doc was shared with
permissionIdstringID of the removed permission
usersjsonMatching users (name, loginId, pictureLink)
groupsjsonMatching groups (groupId, groupName)
canSharebooleanWhether the user can share the doc
canShareWithWorkspacebooleanWhether the user can share with the workspace
canShareWithOrgbooleanWhether the user can share with the org
canCopybooleanWhether the user can copy the doc
allowEditorsToChangePermissionsbooleanWhether editors can change permissions
allowCopyingbooleanWhether viewers can copy the doc
allowViewersToRequestEditingbooleanWhether viewers can request editing
pagesjsonPages (id, name, subtitle, browserLink, contentType, isHidden, icon, image, parent, children, authors, createdAt, updatedAt)
pagejsonPage (id, name, subtitle, href, browserLink, contentType, isHidden, isEffectivelyHidden, icon, image, parent, children, authors, createdAt, createdBy, updatedAt, updatedBy)
pageIdstringID of the created, updated, or deleted page
itemsjsonPage content lines (id, type, style, format, content, lineLevel), or analytics items (doc or page plus daily metrics)
exportIdstringPage export ID
statusstringPage export status (inProgress, failed, complete)
hrefstringAPI link reporting the page export status
downloadLinkstringDownload link of a completed page export
exportErrorstringError message of a failed page export
tablesjsonTables and views (id, name, tableType, href, browserLink, parent)
tablejsonTable (id, name, tableType, browserLink, parent, parentTable, displayColumnId, rowCount, sorts, layout, filter, createdAt, updatedAt)
columnsjsonColumns (id, name, display, calculated, formula, defaultValue, format)
columnjsonColumn (id, name, display, calculated, formula, defaultValue, format, parentTable)
rowsjsonRows (id, name, index, browserLink, createdAt, updatedAt, values)
rowjsonRow (id, name, index, browserLink, createdAt, updatedAt, values, parentTable)
nextSyncTokenstringToken for reading only rows changed later
addedRowIdsjsonIDs of rows that will be added
rowIdstringID of the affected row
rowIdsjsonIDs of rows queued for deletion
columnIdstringID of the pushed button column
formulasjsonNamed formulas (id, name, href, parent)
formulajsonFormula (id, name, href, parent, value)
controlsjsonControls (id, name, href, parent)
controljsonControl (id, name, href, parent, controlType, value)
foldersjsonFolders (id, name, browserLink, description, icon, iconColor, createdAt, canEdit, workspace)
folderjsonFolder (id, name, browserLink, description, icon, iconColor, createdAt, canEdit, workspace)
folderIdstringID of the deleted folder
childrenjsonSubfolders (id, name, browserLink, visibility, workspace, ...)
membersjsonWorkspace members (email, name, role, registeredAt, roleChangedAt, lastActiveAt, ownedDocs, totalDocs, ...)
emailstringEmail of the member whose role changed
newRolestringRole assigned
roleChangedAtstringWhen the role change took effect
roleActivityjsonMonthly role counts (month, activeAdminCount, activeDocMakerCount, activeEditorCount, inactive counts)
totalSessionsnumberTotal sessions across matching docs
docAnalyticsLastUpdatedstringDate doc analytics last updated
packAnalyticsLastUpdatedstringDate Pack analytics last updated
packFormulaAnalyticsLastUpdatedstringDate Pack formula analytics last updated
browserLinkstringCanonical browser link of a resolved resource
resourcejsonResolved resource (type, id, name, href)
completedbooleanWhether a queued change was applied
warningstringWarning for a change that completed with caveats
namestringName of the token owner
loginIdstringEmail of the token owner
pictureLinkstringAvatar link of the token owner
scopedbooleanWhether the token is restricted
tokenNamestringName of the API token
workspacejsonDefault workspace of the token owner (id, name, organizationId, browserLink)
nextPageTokenstringToken for fetching the next page of results

Coda Update Doc

Rename a Coda doc or change its icon. Renaming requires Doc Maker access in the workspace.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
titlestringNoNew title of the doc
iconNamestringNoName of the icon to use (e.g., "rocket")

Output

ParameterTypeDescription
docIdstringID of the updated doc

Coda Update Folder

Rename a Coda folder or change its description. Coda can return the folder as it was before the change; read it again to confirm.

Inputs and outputs

Input

ParameterTypeRequiredDescription
folderIdstringYesID of the folder (e.g., "fl-1Ab234")
namestringNoNew name of the folder
descriptionstringNoNew description of the folder

Output

ParameterTypeDescription
folderobjectThe updated folder

Coda Update Page

Update a Coda page: rename it, change its subtitle, icon, cover, or visibility, and append, prepend, or replace content with Markdown or HTML. Applied asynchronously.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
pageIdstringYesID or name of the page (IDs are recommended, e.g., "canvas-IjkLmnO"; names containing "/" are not supported)
namestringNoNew name of the page
subtitlestringNoNew subtitle of the page (an empty value leaves the subtitle unchanged)
iconNamestringNoName of the page icon (e.g., "rocket")
imageUrlstringNoURL of a cover image for the page
isHiddenbooleanNoWhether the page is hidden (requires a paid Coda plan; ignored for pages that cannot be hidden)
insertionModestringNoHow to apply content: "append", "prepend", or "replace". Required when content is provided.
elementIdstringNoPage element to insert relative to or replace (e.g., "cl-lzqh0Q0poT"); omit to apply to the whole page
contentFormatstringNoContent format: "markdown" (default) or "html"
contentstringNoContent to add to the page in the chosen format

Output

ParameterTypeDescription
pageIdstringID of the updated page

Coda Update Row

Update cell values in a row of a Coda table. Applied asynchronously.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableIdstringYesID or name of the table or view (IDs are recommended, e.g., "grid-pqRst-U"; names containing "/" are not supported)
rowIdstringYesID or name of the row (IDs are recommended, e.g., "i-tuVwxYz"; names containing "/" are not supported)
cellsjsonYesObject mapping column IDs (or names) to new values, e.g., {"c-tuVwxYz": "Done"}, or Coda cells [{"column": "c-tuVwxYz", "value": "Done"}]
disableParsingbooleanNoStore values exactly as given without parsing them

Output

ParameterTypeDescription
rowIdstringID of the updated row

Coda Insert or Upsert Rows

Insert rows into a Coda base table, or update matching rows when key columns are given. Only works on base tables, not views. Applied asynchronously.

Inputs and outputs

Input

ParameterTypeRequiredDescription
docIdstringYesID of the doc (e.g., "AbCDeFGH")
tableIdstringYesID or name of the table or view (IDs are recommended, e.g., "grid-pqRst-U"; names containing "/" are not supported)
rowsjsonYesArray of rows. Each row maps column IDs (or names) to values, e.g., [{"c-tuVwxYz": "Apple", "c-bCdeFgh": 12}], or uses Coda cells [{"cells": [{"column": "c-tuVwxYz", "value": "Apple"}]}]
keyColumnsjsonNoColumn IDs (or names) to match existing rows on, as an array or comma-separated list. Matching rows are updated instead of inserted.
disableParsingbooleanNoStore values exactly as given without parsing them

Output

ParameterTypeDescription
addedRowIdsarrayIDs of rows that will be added (only returned when no key columns are set)

Coda Get Current User

Get the user and default workspace behind the connected Coda API token

Inputs and outputs

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
namestringName of the user
loginIdstringEmail address of the user
pictureLinkstringLink to the user avatar
scopedbooleanWhether the token is restricted to specific docs or tables
tokenNamestringName of the API token
workspaceobjectDefault workspace of the user
Was this helpful?
Suggest an edit