Coda

Learn how to use Coda with Composio

Overview

Enum

CODA

Description

Collaborative workspace platform that transforms documents into powerful tools for team productivity and project management

Authentication Details

api_key
stringRequired

Actions

Returns details about a specific table or view.

Action Parameters

docId
stringRequired
tableIdOrName
stringRequired
useUpdatedTableLayouts
boolean

Action Response

data
object
successful
boolean
error

Returns a list of permissions for this coda doc.

Action Parameters

docId
stringRequired
limit
integerDefaults to 25
pageToken
string

Action Response

data
object
successful
boolean
error

Retrieve the ingestion execution ids of a root ingestion for debugging purpose.

Action Parameters

packId
integerRequired
organizationId
stringRequired
rootIngestionId
stringRequired
logId
stringRequired
detailsKey
stringRequired

Action Response

data
object
successful
boolean
error

Set the system connection credentials of the pack.

Action Parameters

packId
integerRequired
credentials
objectRequired

Action Response

data
object
successful
boolean
error

Note the completion of the upload of a pack asset.

Action Parameters

packId
integerRequired
packAssetId
stringRequired
packAssetType
stringRequired

Action Response

data
object
successful
boolean
error

Returns analytics data for pack formulas.

Action Parameters

packFormulaNames
array
packFormulaTypes
array
packId
integerRequired
sinceDate
string
untilDate
string
scale
string
pageToken
string
orderBy
string
direction
string
limit
integerDefaults to 1000

Action Response

data
object
successful
boolean
error

Add a custom domain to a published doc.

Action Parameters

docId
stringRequired
customDocDomain
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

docId
stringRequired
tableIdOrName
stringRequired
rowIdOrName
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve the logs of a pack for debugging purpose.

Action Parameters

packId
integerRequired
limit
integerDefaults to 25
pageToken
string
docId
stringRequired
logTypes
array
beforeTimestamp
string
afterTimestamp
string
order
string
q
string
requestIds
array

Action Response

data
object
successful
boolean
error

Returns settings associated with acls for this coda doc.

Action Parameters

docId
stringRequired

Action Response

data
object
successful
boolean
error

Add a publishing category for a given pack.

Action Parameters

packId
integerRequired
categoryName
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve the grouped logs of a pack for debugging purpose.

Action Parameters

packId
integerRequired
limit
integerDefaults to 25
pageToken
string
organizationId
stringRequired
rootIngestionId
stringRequired
ingestionExecutionId
string
beforeTimestamp
string
afterTimestamp
string
order
string
q
string

Action Response

data
object
successful
boolean
error

Update details of a pack release.

Action Parameters

packId
integerRequired
packReleaseId
integerRequired
releaseNotes
string

Action Response

data
object
successful
boolean
error

Get the status for an asynchronous mutation to know whether or not it has been completed. each api endpoint that mutates a document will return a request id that you can pass to this endpoint to check the completion status. status information is not guaranteed to be available for more than one day after the mutation was completed. it is intended to be used shortly after the request was made.

Action Parameters

requestId
stringRequired

Action Response

data
object
successful
boolean
error

Check the status of a page content export

Action Parameters

docId
stringRequired
pageIdOrName
stringRequired
requestId
stringRequired

Action Response

data
object
successful
boolean
error

List publishing categories for a given pack.

Action Parameters

packId
integerRequired

Action Response

data
object
successful
boolean
error

Delete a given pack.

Action Parameters

packId
integerRequired

Action Response

data
object
successful
boolean
error

Creates a new pack release based on an existing pack version.

Action Parameters

packId
integerRequired
packVersion
stringRequired
releaseNotes
string

Action Response

data
object
successful
boolean
error

Returns a list of tables in a coda doc.

Action Parameters

docId
stringRequired
limit
integerDefaults to 25
pageToken
string
sortBy
string
tableTypes
array

Action Response

data
object
successful
boolean
error

Returns a list of columns in a table.

Action Parameters

docId
stringRequired
tableIdOrName
stringRequired
limit
integerDefaults to 25
pageToken
string
visibleOnly
boolean

Action Response

data
object
successful
boolean
error

Updates the workspace user role of a user that matches the parameters. only succeeds if the requesting user has admin permissions in the workspace.

Action Parameters

workspaceId
stringRequired
email
stringRequired
newRole
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a custom domain from a published doc.

Action Parameters

docId
stringRequired
customDocDomain
stringRequired

Action Response

data
object
successful
boolean
error

Returns analytics data for packs the user can edit.

Action Parameters

packIds
array
workspaceId
string
query
string
sinceDate
string
untilDate
string
scale
string
pageToken
string
orderBy
string
direction
string
isPublished
boolean
limit
integerDefaults to 1000

Action Response

data
object
successful
boolean
error

Retrieve the system connection metadata of the pack.

Action Parameters

packId
integerRequired

Action Response

data
object
successful
boolean
error

List all custom domains for a published doc.

Action Parameters

docId
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve the logs of a ingestion for debugging purpose.

Action Parameters

packId
integerRequired
limit
integerDefaults to 25
pageToken
string
organizationId
stringRequired
rootIngestionId
stringRequired
logTypes
array
ingestionExecutionId
string
beforeTimestamp
string
afterTimestamp
string
order
string
q
string
requestIds
array

Action Response

data
object
successful
boolean
error

Update an existing pack for non-versioned fields.

Action Parameters

packId
integerRequired
overallRateLimit__intervalSeconds
integer
overallRateLimit__operationsPerInterval
integer
perConnectionRateLimit__intervalSeconds
integer
perConnectionRateLimit__operationsPerInterval
integer
logoAssetId
string
coverAssetId
string
exampleImages
array
sourceCodeVisibility
string
name
string
description
string
shortDescription
string
supportEmail
string
termsOfServiceUrl
string
privacyPolicyUrl
string

Action Response

data
object
successful
boolean
error

Returns summarized analytics data for available docs.

Action Parameters

isPublished
boolean
sinceDate
string
untilDate
string
workspaceId
string

Action Response

data
object
successful
boolean
error

Delete a publishing category for a given pack.

Action Parameters

packId
integerRequired
categoryName
stringRequired

Action Response

data
object
successful
boolean
error

Create or modify user, workspace, or global permissions for a given pack.

Action Parameters

packId
integerRequired
principal
objectRequired
access
stringRequired

Action Response

data
object
successful
boolean
error

Update publish settings for a doc.

Action Parameters

docId
stringRequired
slug
string
discoverable
boolean
earnCredit
boolean
categoryNames
array
mode
string

Action Response

data
object
successful
boolean
error

Creates a new pack, essentially registering a new pack id. the contents of the pack will be uploaded separately.

Action Parameters

workspaceId
string
name
string
description
string
sourcePackId
integer

Action Response

data
object
successful
boolean
error

Deletes a doc.

Action Parameters

docId
stringRequired

Action Response

data
object
successful
boolean
error

Deletes the specified rows from the table or view. this endpoint will always return a 202. row deletions are generally processed within several seconds.

Action Parameters

docId
stringRequired
tableIdOrName
stringRequired
rowIds
arrayRequired

Action Response

data
object
successful
boolean
error

Retrieve the ingestion execution ids of a root ingestion for debugging purpose.

Action Parameters

packId
integerRequired
limit
integerDefaults to 25
pageToken
string
organizationId
stringRequired
rootIngestionId
stringRequired
beforeTimestamp
string
afterTimestamp
string
order
string
ingestionStatus
string
datasource
string
executionType
string
includeDeletedIngestions
boolean
csbIngestionId
string
csbIngestionExecutionId
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

packId
integerRequired

Action Response

data
object
successful
boolean
error

Returns a list of members in the given workspace. this list will be ordered with the requesting user first and then ordered by role.

Action Parameters

workspaceId
stringRequired
includedRoles
array
pageToken
string

Action Response

data
object
successful
boolean
error

Unpublishes a doc.

Action Parameters

docId
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve the grouped logs of a pack for debugging purpose.

Action Parameters

packId
integerRequired
limit
integerDefaults to 25
pageToken
string
docId
stringRequired
beforeTimestamp
string
afterTimestamp
string
order
string
q
string

Action Response

data
object
successful
boolean
error

Returns details about a page.

Action Parameters

docId
stringRequired
pageIdOrName
stringRequired

Action Response

data
object
successful
boolean
error

Gets the provider (ie. godaddy) of a custom domain.

Action Parameters

customDocDomain
stringRequired

Action Response

data
object
successful
boolean
error

Returns basic info about the current user.

Action Parameters

Action Response

data
object
successful
boolean
error

Returns info on a control.

Action Parameters

docId
stringRequired
controlIdOrName
stringRequired

Action Response

data
object
successful
boolean
error

Get the next valid version based on the proposed metadata.

Action Parameters

packId
integerRequired
proposedMetadata
stringRequired
sdkVersion
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

title
string
sourceDoc
string
timezone
string
folderId
string

Action Response

data
object
successful
boolean
error

Get the list of accessible packs.

Action Parameters

accessType
string
accessTypes
array
sortBy
string
limit
integerDefaults to 25
direction
string
pageToken
string
onlyWorkspaceId
string
parentWorkspaceIds
array
excludePublicPacks
boolean
excludeIndividualAcls
boolean
excludeWorkspaceAcls
boolean
includeBrainOnlyPacks
boolean

Action Response

data
object
successful
boolean
error

Update settings associated with acls for this coda doc.

Action Parameters

docId
stringRequired
allowEditorsToChangePermissions
boolean
allowCopying
boolean
allowViewersToRequestEditing
boolean

Action Response

data
object
successful
boolean
error

Returns info on a formula.

Action Parameters

docId
stringRequired
formulaIdOrName
stringRequired

Action Response

data
object
successful
boolean
error

Returns days based on pacific standard time when analytics were last updated.

Action Parameters

Action Response

data
object
successful
boolean
error

Delete a maker for a given pack, who will not be displayed in the corresponding packs page.

Action Parameters

packId
integerRequired
loginId
stringRequired

Action Response

data
object
successful
boolean
error

Request a signed s3 url to upload your pack asset.

Action Parameters

packId
integerRequired
packAssetType
stringRequired
imageHash
stringRequired
mimeType
stringRequired
filename
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

isOwner
boolean
isPublished
boolean
query
string
sourceDoc
string
isStarred
boolean
inGallery
boolean
workspaceId
string
folderId
string
limit
integerDefaults to 25
pageToken
string

Action Response

data
object
successful
boolean
error

Note the completion of the upload of a pack version bundle in order to create that pack version.

Action Parameters

packId
integerRequired
packVersion
stringRequired
notes
string
source
string
allowOlderSdkVersion
boolean

Action Response

data
object
successful
boolean
error

Gets information about the difference between the specified previous version and next version of a pack.

Action Parameters

packId
integerRequired
basePackVersion
stringRequired
targetPackVersion
stringRequired

Action Response

data
object
successful
boolean
error

Initiate an export of content for the given page.

Action Parameters

docId
stringRequired
pageIdOrName
stringRequired
outputFormat
stringRequired

Action Response

data
object
successful
boolean
error

Returns a json schema applicable for customizing the pack using pack configurations.

Action Parameters

packId
integerRequired

Action Response

data
object
successful
boolean
error

Registers a new pack version. this simply returns a signed url to use for uploading the pack version definition. following the completion of the upload, post to /apis/v1/packs/{packid}/versions/{packversion} trigger the rest of the creation process.

Action Parameters

packId
integerRequired
packVersion
stringRequired
bundleHash
stringRequired

Action Response

data
object
successful
boolean
error

Returns a list of controls in a coda doc.

Action Parameters

docId
stringRequired
limit
integerDefaults to 25
pageToken
string
sortBy
string

Action Response

data
object
successful
boolean
error

Get the list of releases of a pack.

Action Parameters

packId
integerRequired
limit
integerDefaults to 25
pageToken
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

docId
stringRequired
tableIdOrName
stringRequired
query
string
sortBy
string
useColumnNames
boolean
valueFormat
string
visibleOnly
boolean
limit
integerDefaults to 25
pageToken
string
syncToken
string

Action Response

data
object
successful
boolean
error

Set a maker for a given pack. used to display makers for a pack in the corresponding packs page.

Action Parameters

packId
integerRequired
loginId
stringRequired

Action Response

data
object
successful
boolean
error

Get detailed listing information for a pack.

Action Parameters

packId
integerRequired
workspaceId
string
docId
string
installContext
string
releaseChannel
string

Action Response

data
object
successful
boolean
error

Patch the system connection credentials of the pack.

Action Parameters

packId
integerRequired

Action Response

data
object
successful
boolean
error

Note the completion of the upload of a pack source code.

Action Parameters

packId
integerRequired
packVersion
stringRequired
filename
stringRequired
codeHash
stringRequired

Action Response

data
object
successful
boolean
error

Searches for user and group principals matching the query that this doc can be shared with. at most 20 results will be returned for both users and groups. if no query is given then no results are returned.

Action Parameters

docId
stringRequired
query
string

Action Response

data
object
successful
boolean
error

Update properties for a page. note that updating a page title or icon requires you to be a doc maker in the applicable workspace.

Action Parameters

docId
stringRequired
pageIdOrName
stringRequired
name
string
subtitle
string
iconName
string
imageUrl
string
isHidden
boolean

Action Response

data
object
successful
boolean
error

Returns analytics data for a given doc within the day. this method will return a 401 if the given doc is not in an enterprise workspace.

Action Parameters

docId
stringRequired
sinceDate
string
untilDate
string
pageToken
string
limit
integerDefaults to 1000

Action Response

data
object
successful
boolean
error

Delete user, workspace, or global permissions for a given pack.

Action Parameters

packId
integerRequired
permissionId
stringRequired

Action Response

data
object
successful
boolean
error

Adds a new permission to the doc.

Action Parameters

docId
stringRequired
access
stringRequired
principal
objectRequired
suppressEmail
boolean

Action Response

data
object
successful
boolean
error

Create a new page in a doc. note that creating a page requires you to be a doc maker in the applicable workspace.

Action Parameters

docId
stringRequired
name
string
subtitle
string
iconName
string
imageUrl
string
parentPageId
string
pageContent
object

Action Response

data
object
successful
boolean
error

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.

Action Parameters

docId
stringRequired
tableIdOrName
stringRequired
rowIdOrName
stringRequired
columnIdOrName
stringRequired

Action Response

data
object
successful
boolean
error

Gets all available doc categories.

Action Parameters

Action Response

data
object
successful
boolean
error

Returns a list of named formulas in a coda doc.

Action Parameters

docId
stringRequired
limit
integerDefaults to 25
pageToken
string
sortBy
string

Action Response

data
object
successful
boolean
error

Returns a list of the counts of users over time by role for the workspace.

Action Parameters

workspaceId
stringRequired

Action Response

data
object
successful
boolean
error

Returns a single pack.

Action Parameters

packId
integerRequired

Action Response

data
object
successful
boolean
error

Returns metadata associated with sharing for this coda doc.

Action Parameters

docId
stringRequired

Action Response

data
object
successful
boolean
error

Returns details about a column in a table.

Action Parameters

docId
stringRequired
tableIdOrName
stringRequired
columnIdOrName
stringRequired

Action Response

data
object
successful
boolean
error

Set the oauth configurations of the pack, including client id and secret.

Action Parameters

packId
integerRequired
clientId
string
clientSecret
string
redirectUri
string

Action Response

data
object
successful
boolean
error

Updates metadata for a doc. note that updating a doc title requires you to be a doc maker in the applicable workspace.

Action Parameters

docId
stringRequired
title
string
iconName
string

Action Response

data
object
successful
boolean
error

Get temporary links used to download the source code for the given packid and version

Action Parameters

packId
integerRequired
packVersion
stringRequired

Action Response

data
object
successful
boolean
error

Request a signed s3 url to upload your pack source code.

Action Parameters

packId
integerRequired
payloadHash
stringRequired
filename
stringRequired
packVersion
string

Action Response

data
object
successful
boolean
error

Returns metadata for the specified doc.

Action Parameters

docId
stringRequired

Action Response

data
object
successful
boolean
error

Retrieve the oauth configuration of the pack for display purpose. secrets will be returned with masks.

Action Parameters

packId
integerRequired

Action Response

data
object
successful
boolean
error

Deletes the specified page.

Action Parameters

docId
stringRequired
pageIdOrName
stringRequired

Action Response

data
object
successful
boolean
error

Returns details about a row in a table.

Action Parameters

docId
stringRequired
tableIdOrName
stringRequired
rowIdOrName
stringRequired
useColumnNames
boolean
valueFormat
string

Action Response

data
object
successful
boolean
error

Get the list of versions of a pack.

Action Parameters

packId
integerRequired
limit
integerDefaults to 25
pageToken
string

Action Response

data
object
successful
boolean
error

Returns analytics data for available docs per day.

Action Parameters

docIds
array
workspaceId
string
query
string
isPublished
boolean
sinceDate
string
untilDate
string
scale
string
pageToken
string
orderBy
string
direction
string
limit
integerDefaults to 1000

Action Response

data
object
successful
boolean
error

Get listings of public packs and packs created by you.

Action Parameters

packAccessTypes
array
packIds
array
onlyWorkspaceId
string
parentWorkspaceIds
array
excludePublicPacks
boolean
excludeWorkspaceAcls
boolean
excludeIndividualAcls
boolean
includeBrainOnlyPacks
boolean
sortBy
string
orderBy
string
direction
string
limit
integerDefaults to 5
pageToken
string
installContext
string

Action Response

data
object
successful
boolean
error

Deletes an existing permission.

Action Parameters

docId
stringRequired
permissionId
stringRequired

Action Response

data
object
successful
boolean
error

Triggers webhook-invoked automation

Action Parameters

docId
stringRequired
ruleId
stringRequired

Action Response

data
object
successful
boolean
error

List makers for a given pack.

Action Parameters

packId
integerRequired

Action Response

data
object
successful
boolean
error

Updates properties of a document’s custom domain.

Action Parameters

docId
stringRequired
customDocDomain
stringRequired

Action Response

data
object
successful
boolean
error

Returns summarized analytics data for packs the user can edit.

Action Parameters

packIds
array
workspaceId
string
isPublished
boolean
sinceDate
string
untilDate
string

Action Response

data
object
successful
boolean
error

Returns a list of pages in a coda doc.

Action Parameters

docId
stringRequired
limit
integerDefaults to 25
pageToken
string

Action Response

data
object
successful
boolean
error