Coda

coda

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

Productivity Project Management Web del proveedor

Acciones

101

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (101)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add a category for packCODA_ADD_A_CATEGORY_FOR_PACKAcción

Add a publishing category for a given pack.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
categoryNamestringObligatorio
Name of the publishing category.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a maker for packCODA_ADD_A_MAKER_FOR_PACKAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
loginIdstringObligatorio
The email of the Pack maker.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add a permission for packCODA_ADD_A_PERMISSION_FOR_PACKAcción

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

Parámetros de entrada

accessstringObligatorioenum
Access
viewtesteditadmin
packIdintegerObligatorio
ID of a Pack
principalobjectObligatorio
Metadata about a Pack principal.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add custom domainCODA_ADD_CUSTOM_DOMAINAcción

Add a custom domain to a published doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
customDocDomainstringObligatorio
The custom domain.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add permissionCODA_ADD_PERMISSIONAcción

Adds a new permission to the doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
accessstringObligatorioenum
Type of access (excluding none).
readonlywritecomment
principalobjectObligatorio
Metadata about a principal to add to a doc.
suppressEmailboolean
When true suppresses email notification

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Begin content exportCODA_BEGIN_CONTENT_EXPORTAcción

Initiate an export of content for the given page.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
outputFormatstringObligatorioenum
Supported output content formats that can be requested for getting content for an existing page.
htmlmarkdown
pageIdOrNamestringObligatorio
ID or name of the page. Names are discouraged because they"re easily prone to being changed by users. If you"re using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Content export statusCODA_CONTENT_EXPORT_STATUSAcción

Check the status of a page content export

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Copy DocumentCODA_COPY_DOCAcción

Creates a copy of an existing coda document. this action allows you to duplicate a document while optionally specifying a new title and location for the copied document.

Parámetros de entrada

titlestring
Title for the new document. If not specified, defaults to 'Untitled'.
timezonestring
The timezone to use for the newly created document.
folder_idstring
The ID of the folder where the new document will be created. If not specified, defaults to your 'My docs' folder.
source_doc_idstringObligatorio
ID of the existing document to copy.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a new pack releaseCODA_CREATE_A_NEW_PACK_RELEASEAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
packVersionstringObligatorio
Which semantic pack version that the release will be created on.
releaseNotesstring
Developers notes.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a pageCODA_CREATE_A_PAGEAcción

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

Parámetros de entrada

namestring
Name of the page.
docIdstringObligatorio
ID of the doc.
iconNamestring
Name of the icon.
imageUrlstring
Url of the cover image to use.
subtitlestring
Subtitle of the page.
pageContentobject
Content that can be added to a page at creation time, either text (or rich text) or a URL to create a full-page embed.
parentPageIdstring
The ID of this new page"s parent, if creating a subpage.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create docCODA_CREATE_DOCAcción

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

Parámetros de entrada

titlestring
Title of the new doc. Defaults to "Untitled".
folderIdstring
The ID of the folder within which to create this doc. Defaults to your "My docs" folder in the oldest workspace you joined; this is subject to change. You can get this ID by opening the folder in the docs list on your computer and grabbing the `folderId` query parameter.
timezonestring
The timezone to use for the newly created doc.
sourceDocstring
An optional doc ID from which to create a copy.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create packCODA_CREATE_PACKAcción

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

Parámetros de entrada

namestring
The name for the Pack.
descriptionstring
A brief description of the Pack.
workspaceIdstring
The parent workspace for the Pack. If unspecified, the user"s default workspace will be used.
sourcePackIdinteger
The ID of the new Pack"s source, if this new Pack was forked.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a category for packCODA_DELETE_A_CATEGORY_FOR_PACKAcción

Delete a publishing category for a given pack.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
categoryNamestringObligatorio
Name of a publishing category

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a maker for packCODA_DELETE_A_MAKER_FOR_PACKAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
loginIdstringObligatorio
Email of a Coda user.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a pageCODA_DELETE_A_PAGEAcción

Deletes the specified page.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a permission for packCODA_DELETE_A_PERMISSION_FOR_PACKAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
permissionIdstringObligatorio
ID of a permission on a doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete docCODA_DELETE_DOCAcción

Deletes a doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete multiple rowsCODA_DELETE_MULTIPLE_ROWSAcción

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

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
rowIdsstring[]Obligatorio
Row IDs to delete.
tableIdOrNamestringObligatorio
ID or name of the table. Names are discouraged because they"re easily prone to being changed by users. If you"re using a name, be sure to URI-encode it.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete packCODA_DELETE_PACKAcción

Delete a given pack.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete permissionCODA_DELETE_PERMISSIONAcción

Deletes an existing permission.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
permissionIdstringObligatorio
ID of a permission on a doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete rowCODA_DELETE_ROWAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Deletes a custom domainCODA_DELETES_A_CUSTOM_DOMAINAcción

Deletes a custom domain from a published doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
customDocDomainstringObligatorio
A custom domain for a published doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch grouped logs by pack org root ingestion idCODA_FETCH_GROUPED_LOGS_BY_PACK_ORG_ROOT_INGESTION_IDAcción

Retrieve the grouped logs of a pack for debugging purpose.

Parámetros de entrada

qstring
A search query that follows Lucene syntax.
limitinteger
Maximum number of results to return in this query.
orderstringenum
Specifies if the logs will be returned in time desc or asc. Default is desc.
ascdesc
packIdintegerObligatorio
ID of a Pack
pageTokenstring
An opaque token used to fetch the next page of results.
afterTimestampstring
Only return logs after the given time (non-inclusive).
organizationIdstringObligatorio
ID of the organization.
beforeTimestampstring
Only return logs before the given time (non-inclusive).
rootIngestionIdstringObligatorio
ID of the root ingestion.
ingestionExecutionIdstring
ID of the ingestion execution.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch ingestion executions for packCODA_FETCH_INGESTION_EXECUTIONS_FOR_PACKAcción

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

Parámetros de entrada

limitinteger
Maximum number of results to return in this query.
orderstringenum
Specifies if the logs will be returned in time desc or asc. Default is desc.
ascdesc
packIdintegerObligatorio
ID of a Pack
pageTokenstring
An opaque token used to fetch the next page of results.
datasourcestring
Datasource of the ingestion execution to filter to
executionTypestringenum
Execution type of the ingestion execution to filter to
FULLINCREMENTAL
afterTimestampstring
Only return logs after the given time (non-inclusive).
csbIngestionIdstring
Ingestion id of the ingestion execution to filter to
organizationIdstringObligatorio
ID of the organization.
beforeTimestampstring
Only return logs before the given time (non-inclusive).
ingestionStatusstringenum
Status of the ingestion execution to filter to
QUEUEDSTARTEDCANCELLEDUP_FOR_RETRYCOMPLETEDFAILED
rootIngestionIdstringObligatorio
ID of the root ingestion.
csbIngestionExecutionIdstring
Ingestion execution id of the ingestion execution to filter to
includeDeletedIngestionsboolean
Include deleted ingestion executions in the response

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get acl settingsCODA_GET_ACL_SETTINGSAcción

Returns settings associated with acls for this coda doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a columnCODA_GET_A_COLUMNAcción

Returns details about a column in a table.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
tableIdOrNamestringObligatorio
ID or name of the table. Names are discouraged because they"re easily prone to being changed by users. If you"re using a name, be sure to URI-encode it.
columnIdOrNamestringObligatorio
ID or name of the column. Names are discouraged because they"re easily prone to being changed by users. If you"re using a name, be sure to URI-encode it.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a controlCODA_GET_A_CONTROLAcción

Returns info on a control.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a formulaCODA_GET_A_FORMULAAcción

Returns info on a formula.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get analytics last updated dayCODA_GET_ANALYTICS_LAST_UPDATED_DAYAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a pageCODA_GET_A_PAGEAcción

Returns details about a page.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a rowCODA_GET_A_ROWAcción

Returns details about a row in a table.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
rowIdOrNamestringObligatorio
ID or name of the row. Names are discouraged because they"re easily prone to being changed by users. If you"re using a name, be sure to URI-encode it. If there are multiple rows with the same value in the identifying column, an arbitrary one will be selected.
valueFormatstringenum
The format that cell values are returned as.
simplesimpleWithArraysrich
tableIdOrNamestringObligatorio
ID or name of the table. Names are discouraged because they"re easily prone to being changed by users. If you"re using a name, be sure to URI-encode it.
useColumnNamesboolean
Use column names instead of column IDs in the returned output. This is generally discouraged as it is fragile. If columns are renamed, code using original names may throw errors.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a single packCODA_GET_A_SINGLE_PACKAcción

Returns a single pack.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a tableCODA_GET_A_TABLEAcción

Returns details about a specific table or view.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get detailed listing information for a packCODA_GET_DETAILED_LISTING_INFORMATION_FOR_A_PACKAcción

Get detailed listing information for a pack.

Parámetros de entrada

docIdstring
ID of the target document for checking installation privileges
packIdintegerObligatorio
ID of a Pack
workspaceIdstring
ID of the target workspace (if applicable) for checking installation privileges.
installContextstringenum
Type of installation context for which Pack information is being requested.
workspacedoc
releaseChannelstringenum
Release channel for which Pack information is being requested.
LIVELATEST

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get doc analytics summaryCODA_GET_DOC_ANALYTICS_SUMMARYAcción

Returns summarized analytics data for available docs.

Parámetros de entrada

sinceDatestring
Limit results to activity on or after this date.
untilDatestring
Limit results to activity on or before this date.
isPublishedboolean
Limit results to only published items.
workspaceIdstring
ID of the workspace.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get doc categoriesCODA_GET_DOC_CATEGORIESAcción

Gets all available doc categories.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get info about a docCODA_GET_INFO_ABOUT_A_DOCAcción

Returns metadata for the specified doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get mutation statusCODA_GET_MUTATION_STATUSAcción

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.

Parámetros de entrada

requestIdstringObligatorio
ID of the request.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get pack analytics summaryCODA_GET_PACK_ANALYTICS_SUMMARYAcción

Returns summarized analytics data for packs the user can edit.

Parámetros de entrada

packIdsinteger[]
Which Pack IDs to fetch.
sinceDatestring
Limit results to activity on or after this date.
untilDatestring
Limit results to activity on or before this date.
isPublishedboolean
Limit results to only published items. If false or unspecified, returns all items including published ones.
workspaceIdstring
ID of the workspace.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Gets custom doc domains providersCODA_GETS_CUSTOM_DOC_DOMAINS_PROVIDERSAcción

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

Parámetros de entrada

customDocDomainstringObligatorio
A custom domain for a published doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get sharing metadataCODA_GET_SHARING_METADATAAcción

Returns metadata associated with sharing for this coda doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Gets the json schema for pack configurationCODA_GETS_THE_JSON_SCHEMA_FOR_PACK_CONFIGURATIONAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the difference between two pack versionsCODA_GET_THE_DIFFERENCE_BETWEEN_TWO_PACK_VERSIONSAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
basePackVersionstringObligatorio
Semantic version of the previous Pack version.
targetPackVersionstringObligatorio
Semantic version of the new Pack version.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the next valid version for a packCODA_GET_THE_NEXT_VALID_VERSION_FOR_A_PACKAcción

Get the next valid version based on the proposed metadata.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
sdkVersionstring
The SDK version the metadata was built on.
proposedMetadatastringObligatorio
The metadata for the next version of the Pack.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the source code for a pack versionCODA_GET_THE_SOURCE_CODE_FOR_A_PACK_VERSIONAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
packVersionstringObligatorio
Semantic version of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get user infoCODA_GET_USER_INFOAcción

Returns basic info about the current user.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List available docsCODA_LIST_AVAILABLE_DOCSAcción

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

Parámetros de entrada

limitinteger
Maximum number of results to return in this query.
querystring
Search term used to filter down results.
isOwnerboolean
Show only docs owned by the user.
folderIdstring
Show only docs belonging to the given folder.
inGalleryboolean
Show only docs visible within the gallery.
isStarredboolean
If true, returns docs that are starred. If false, returns docs that are not starred.
pageTokenstring
An opaque token used to fetch the next page of results.
sourceDocstring
Show only docs copied from the specified doc ID.
isPublishedboolean
Show only published docs.
workspaceIdstring
Show only docs belonging to the given workspace.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List categories for packCODA_LIST_CATEGORIES_FOR_PACKAcción

List publishing categories for a given pack.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List columnsCODA_LIST_COLUMNSAcción

Returns a list of columns in a table.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List controlsCODA_LIST_CONTROLSAcción

Returns a list of controls in a coda doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
limitinteger
Maximum number of results to return in this query.
sortBystringenum
Determines how to sort the given objects.
name
pageTokenstring
An opaque token used to fetch the next page of results.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List custom doc domainsCODA_LIST_CUSTOM_DOC_DOMAINSAcción

List all custom domains for a published doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List doc analyticsCODA_LIST_DOC_ANALYTICSAcción

Returns analytics data for available docs per day.

Parámetros de entrada

limitinteger
Maximum number of results to return in this query.
querystring
Search term used to filter down results.
scalestringenum
Quantization period over which to view analytics. Defaults to daily.
dailycumulative
docIdsstring[]
List of docIds to fetch.
orderBystringenum
Use this parameter to order the doc analytics returned.
datedocIdtitlecreatedAtpublishedAtlikescopiesviewssessionsDesktopsessionsMobilesessionsOthertotalSessions+6
directionstringenum
Direction to sort results in.
ascendingdescending
pageTokenstring
An opaque token used to fetch the next page of results.
sinceDatestring
Limit results to activity on or after this date.
untilDatestring
Limit results to activity on or before this date.
isPublishedboolean
Limit results to only published items.
workspaceIdstring
ID of the workspace.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List featured docs for a packCODA_LIST_FEATURED_DOCS_FOR_A_PACKAcción

Returns a list of featured doc ids for a pack.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List formulasCODA_LIST_FORMULASAcción

Returns a list of named formulas in a coda doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
limitinteger
Maximum number of results to return in this query.
sortBystringenum
Determines how to sort the given objects.
name
pageTokenstring
An opaque token used to fetch the next page of results.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List makers for packCODA_LIST_MAKERS_FOR_PACKAcción

List makers for a given pack.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List pack analyticsCODA_LIST_PACK_ANALYTICSAcción

Returns analytics data for packs the user can edit.

Parámetros de entrada

limitinteger
Maximum number of results to return in this query.
querystring
Search term used to filter down results.
scalestringenum
Quantization period over which to view analytics. Defaults to daily.
dailycumulative
orderBystringenum
Use this parameter to order the Pack analytics returned.
datepackIdnamecreatedAtdocInstallsworkspaceInstallsnumFormulaInvocationsnumActionInvocationsnumSyncInvocationsnumMetadataInvocationsdocsActivelyUsingdocsActivelyUsing7Day+11
packIdsinteger[]
Which Pack IDs to fetch.
directionstringenum
Direction to sort results in.
ascendingdescending
pageTokenstring
An opaque token used to fetch the next page of results.
sinceDatestring
Limit results to activity on or after this date.
untilDatestring
Limit results to activity on or before this date.
isPublishedboolean
Limit results to only published items. If false or unspecified, returns all items including published ones.
workspaceIdstring
ID of the workspace.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List pack formula analyticsCODA_LIST_PACK_FORMULA_ANALYTICSAcción

Returns analytics data for pack formulas.

Parámetros de entrada

limitinteger
Maximum number of results to return in this query.
scalestringenum
Quantization period over which to view analytics. Defaults to daily.
dailycumulative
packIdintegerObligatorio
ID of a Pack
orderBystringenum
Use this parameter to order the Pack formula analytics returned.
dateformulaNameformulaTypeformulaInvocationsmedianLatencyMsmedianResponseSizeByteserrorsdocsActivelyUsingdocsActivelyUsing7DaydocsActivelyUsing30DaydocsActivelyUsing90DaydocsActivelyUsingAllTime+5
directionstringenum
Direction to sort results in.
ascendingdescending
pageTokenstring
An opaque token used to fetch the next page of results.
sinceDatestring
Limit results to activity on or after this date.
untilDatestring
Limit results to activity on or before this date.
packFormulaNamesstring[]
A list of Pack formula names (case-sensitive) for which to retrieve analytics.
packFormulaTypesstring[]
A list of Pack formula types corresponding to the `packFormulaNames`. If specified, this must have the same length as `packFormulaNames`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List packsCODA_LIST_PACKSAcción

Get the list of accessible packs.

Parámetros de entrada

limitinteger
Maximum number of results to return in this query.
sortBystringenum
The sort order of the Packs returned.
titlecreatedAtupdatedAt
directionstringenum
Direction to sort results in.
ascendingdescending
pageTokenstring
An opaque token used to fetch the next page of results.
accessTypestringenum
Deprecated, use accessTypes instead. Filter to only return the Packs for which the current user has this access type
viewtesteditadmin
accessTypesstring[]
Filter to only return the Packs for which the current user has these access types.
onlyWorkspaceIdstring
Use only this workspace (not all of a user"s workspaces) to check for Packs shared via workspace ACL.
excludePublicPacksboolean
Only get Packs shared with users/workspaces, not publicly.
parentWorkspaceIdsstring[]
Filter to only Packs whose parent workspace is one of the given IDs.
excludeWorkspaceAclsboolean
Do not include Packs that are only shared with workspaces.
excludeIndividualAclsboolean
Do not include Packs that are only shared with the user individually.
includeBrainOnlyPacksboolean
Include Packs that only support Coda Brain.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List page analyticsCODA_LIST_PAGE_ANALYTICSAcción

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.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
limitinteger
Maximum number of results to return in this query.
pageTokenstring
An opaque token used to fetch the next page of results.
sinceDatestring
Limit results to activity on or after this date.
untilDatestring
Limit results to activity on or before this date.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List pagesCODA_LIST_PAGESAcción

Returns a list of pages in a coda doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
limitinteger
Maximum number of results to return in this query.
pageTokenstring
An opaque token used to fetch the next page of results.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List permissionsCODA_LIST_PERMISSIONSAcción

Returns a list of permissions for this coda doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
limitinteger
Maximum number of results to return in this query.
pageTokenstring
An opaque token used to fetch the next page of results.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List permissions for a packCODA_LIST_PERMISSIONS_FOR_A_PACKAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List table rowsCODA_LIST_TABLE_ROWSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List tablesCODA_LIST_TABLESAcción

Returns a list of tables in a coda doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
limitinteger
Maximum number of results to return in this query.
sortBystringenum
Determines how to sort the given objects.
name
pageTokenstring
An opaque token used to fetch the next page of results.
tableTypesstring[]
Comma-separated list of table types to include in results. If omitted, includes both tables and views.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List the pack listings accessible to a userCODA_LIST_THE_PACK_LISTINGS_ACCESSIBLE_TO_A_USERAcción

Get listings of public packs and packs created by you.

Parámetros de entrada

limitinteger
Maximum number of results to return in this query.
sortBystringenum
Specify a sort order for the returned Pack listings returned.
packIdnamepackVersionpackVersionModifiedAt
orderBystringenum
Deprecated: use sortBy instead.
packIdnamepackVersionpackVersionModifiedAt
packIdsinteger[]
Which Pack IDs to fetch.
directionstringenum
Direction to sort results in.
ascendingdescending
pageTokenstring
An opaque token used to fetch the next page of results.
installContextstringenum
Type of installation context for which Pack information is being requested.
workspacedoc
onlyWorkspaceIdstring
Use only this workspace (not all of a user"s workspaces) to check for Packs shared via workspace ACL.
packAccessTypesstring[]
Pack access types.
excludePublicPacksboolean
Only get Packs shared with users/workspaces, not publicly.
parentWorkspaceIdsstring[]
Filter to only Packs whose parent workspace is one of the given IDs.
excludeWorkspaceAclsboolean
Do not include Packs that are only shared with workspaces.
excludeIndividualAclsboolean
Do not include Packs that are only shared with the user individually.
includeBrainOnlyPacksboolean
Include Packs that only support Coda Brain.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List the releases for a packCODA_LIST_THE_RELEASES_FOR_A_PACKAcción

Get the list of releases of a pack.

Parámetros de entrada

limitinteger
Maximum number of results to return in this query.
packIdintegerObligatorio
ID of a Pack
pageTokenstring
An opaque token used to fetch the next page of results.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List the versions for a packCODA_LIST_THE_VERSIONS_FOR_A_PACKAcción

Get the list of versions of a pack.

Parámetros de entrada

limitinteger
Maximum number of results to return in this query.
packIdintegerObligatorio
ID of a Pack
pageTokenstring
An opaque token used to fetch the next page of results.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List workspace rolesCODA_LIST_WORKSPACE_ROLESAcción

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

Parámetros de entrada

workspaceIdstringObligatorio
ID of the workspace.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List workspace usersCODA_LIST_WORKSPACE_USERSAcción

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

Parámetros de entrada

pageTokenstring
An opaque token used to fetch the next page of results.
workspaceIdstringObligatorio
ID of the workspace.
includedRolesstring[]
Show only the members that match the included roles. Multiple roles can be specified with a comma-delimited list.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Pack asset upload completeCODA_PACK_ASSET_UPLOAD_COMPLETEAcción

Note the completion of the upload of a pack asset.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
packAssetIdstringObligatorio
Unique identifier for a Pack asset.
packAssetTypestringObligatorioenum
Pack asset type.
logocoverexampleImage

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Pack source code upload completeCODA_PACK_SOURCE_CODE_UPLOAD_COMPLETEAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
codeHashstringObligatorio
A SHA-256 hash of the source code used to identify duplicate uploads.
filenamestringObligatorio
Filename
packVersionstringObligatorio
Semantic version of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Pack version upload completeCODA_PACK_VERSION_UPLOAD_COMPLETEAcción

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

Parámetros de entrada

notesstring
Developer notes of the new Pack version.
packIdintegerObligatorio
ID of a Pack
sourcestringenum
Source
webcli
packVersionstringObligatorio
Semantic version of a Pack
allowOlderSdkVersionboolean
Bypass Coda"s protection against SDK version regression when multiple makers build versions.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch the system connection credentials of the packCODA_PATCH_THE_SYSTEM_CONNECTION_CREDENTIALS_OF_THE_PACKAcción

Patch the system connection credentials of the pack.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Publish docCODA_PUBLISH_DOCAcción

Update publish settings for a doc.

Parámetros de entrada

modestringenum
Which interaction mode the published doc should use.
viewplayedit
slugstring
Slug for the published doc.
docIdstringObligatorio
ID of the doc.
earnCreditboolean
If true, new users may be required to sign in to view content within this document. You will receive Coda credit for each user who signs up via your doc.
discoverableboolean
If true, indicates that the doc is discoverable.
categoryNamesstring[]
The names of categories to apply to the document.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Push a buttonCODA_PUSH_A_BUTTONAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

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.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
bundleHashstringObligatorio
The SHA-256 hash of the file to be uploaded.
packVersionstringObligatorio
Semantic version of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Resolve browser linkCODA_RESOLVE_BROWSER_LINKAcción

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.

Parámetros de entrada

urlstringObligatorio
The browser link to try to resolve.
degradeGracefullyboolean
By default, attempting to resolve the Coda URL of a deleted object will result in an error. If this flag is set, the next-available object, all the way up to the doc itself, will be resolved.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve the grouped logs of a packCODA_RETRIEVE_THE_GROUPED_LOGS_OF_A_PACKAcción

Retrieve the grouped logs of a pack for debugging purpose.

Parámetros de entrada

qstring
A search query that follows Lucene syntax.
docIdstringObligatorio
ID of the doc.
limitinteger
Maximum number of results to return in this query.
orderstringenum
Specifies if the logs will be returned in time desc or asc. Default is desc.
ascdesc
packIdintegerObligatorio
ID of a Pack
pageTokenstring
An opaque token used to fetch the next page of results.
afterTimestampstring
Only return logs after the given time (non-inclusive).
beforeTimestampstring
Only return logs before the given time (non-inclusive).

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve the information for a specific logCODA_RETRIEVE_THE_INFORMATION_FOR_A_SPECIFIC_LOGAcción

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

Parámetros de entrada

logIdstringObligatorio
The id of the log to retrieve.
packIdintegerObligatorio
ID of a Pack
detailsKeystringObligatorio
The key of the details to retrieve.
organizationIdstringObligatorio
ID of the organization.
rootIngestionIdstringObligatorio
ID of the root ingestion.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve the logs of a ingestionCODA_RETRIEVE_THE_LOGS_OF_A_INGESTIONAcción

Retrieve the logs of a ingestion for debugging purpose.

Parámetros de entrada

qstring
A search query that follows Lucene syntax.
limitinteger
Maximum number of results to return in this query.
orderstringenum
Specifies if the logs will be returned in time desc or asc. Default is desc.
ascdesc
packIdintegerObligatorio
ID of a Pack
logTypesstring[]
Only return logs of the given types.
pageTokenstring
An opaque token used to fetch the next page of results.
requestIdsstring[]
Only return logs matching provided request IDs.
afterTimestampstring
Only return logs after the given time (non-inclusive).
organizationIdstringObligatorio
ID of the organization.
beforeTimestampstring
Only return logs before the given time (non-inclusive).
rootIngestionIdstringObligatorio
ID of the root ingestion.
ingestionExecutionIdstring
ID of the ingestion execution.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve the logs of a packCODA_RETRIEVE_THE_LOGS_OF_A_PACKAcción

Retrieve the logs of a pack for debugging purpose.

Parámetros de entrada

qstring
A search query that follows Lucene syntax.
docIdstringObligatorio
ID of the doc.
limitinteger
Maximum number of results to return in this query.
orderstringenum
Specifies if the logs will be returned in time desc or asc. Default is desc.
ascdesc
packIdintegerObligatorio
ID of a Pack
logTypesstring[]
Only return logs of the given types.
pageTokenstring
An opaque token used to fetch the next page of results.
requestIdsstring[]
Only return logs matching provided request IDs.
afterTimestampstring
Only return logs after the given time (non-inclusive).
beforeTimestampstring
Only return logs before the given time (non-inclusive).

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve the oauth configuration of the packCODA_RETRIEVE_THE_OAUTH_CONFIGURATION_OF_THE_PACKAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve the system connection metadata of the packCODA_RETRIEVE_THE_SYSTEM_CONNECTION_METADATA_OF_THE_PACKAcción

Retrieve the system connection metadata of the pack.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Coda DocumentsCODA_SEARCH_DOCSAcción

This tool allows users to search for coda documents based on a query term. it searches within document titles and metadata, providing results with document id, name, type, owner details, timestamps, workspace info, and folder path if available. it supports pagination through the 'pagetoken' parameter and accepts a 'limit' parameter to control the number of returned results.

Parámetros de entrada

limitinteger
Maximum number of results to return in this query. Default is 25.
querystring
Search term used to filter results. Searches within document titles and metadata.
is_ownerboolean
If true, returns only docs owned by the user.
folder_idstring
Show only docs belonging to the given folder ID.
page_tokenstring
An opaque token used to fetch the next page of results.
is_publishedboolean
If true, returns only published docs.
workspace_idstring
Show only docs belonging to the given workspace ID.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search principalsCODA_SEARCH_PRINCIPALSAcción

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.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
querystring
Search term used to filter down results.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Table RowsCODA_SEARCH_ROWAcción

Action to search for rows in a coda table based on specific criteria.

Parámetros de entrada

limitinteger
Maximum number of results to return in this query.
querystring
Query to filter rows, specified as column_id_or_name:value. For column names with spaces, use quotes, e.g. "My Column":123
doc_idstringObligatorio
ID of the doc containing the table.
value_formatstringenum
Enum for value format options.
simplesimpleWithArraysrich
visible_onlyboolean
If true, returns only visible rows and columns for the table.
table_id_or_namestringObligatorio
ID or name of the table to search in. Names are discouraged as they can change.
use_column_namesboolean
Use column names instead of column IDs in the returned output. This is generally discouraged as names can change.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set the oauth configurations of the packCODA_SET_THE_OAUTH_CONFIGURATIONS_OF_THE_PACKAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
clientIdstring
Clientid
redirectUristring
Redirecturi
clientSecretstring
Clientsecret

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set the system connection credentials of the packCODA_SET_THE_SYSTEM_CONNECTION_CREDENTIALS_OF_THE_PACKAcción

Set the system connection credentials of the pack.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
credentialsobjectObligatorio
Credentials of a Pack connection.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Trigger automationCODA_TRIGGER_AUTOMATIONAcción

Triggers webhook-invoked automation

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
ruleIdstringObligatorio
ID of the automation rule.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unpublish docCODA_UNPUBLISH_DOCAcción

Unpublishes a doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update acl settingsCODA_UPDATE_ACL_SETTINGSAcción

Update settings associated with acls for this coda doc.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
allowCopyingboolean
When true, allows doc viewers to copy the doc.
allowViewersToRequestEditingboolean
When true, allows doc viewers to request editing permissions.
allowEditorsToChangePermissionsboolean
When true, allows editors to change doc permissions. When false, only doc owner can change doc permissions.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an existing pack releaseCODA_UPDATE_AN_EXISTING_PACK_RELEASEAcción

Update details of a pack release.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
releaseNotesstring
Notes about key features or changes in this release that the Pack maker wants to communicate to users.
packReleaseIdintegerObligatorio
ID of a Pack release

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a pageCODA_UPDATE_A_PAGEAcción

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

Parámetros de entrada

namestring
Name of the page.
docIdstringObligatorio
ID of the doc.
iconNamestring
Name of the icon.
imageUrlstring
Url of the cover image to use.
isHiddenboolean
Whether the page is hidden or not. Note that for pages that cannot be hidden, like the sole top-level page in a doc, this will be ignored.
subtitlestring
Subtitle of the page.
pageIdOrNamestringObligatorio
ID or name of the page. Names are discouraged because they"re easily prone to being changed by users. If you"re using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update docCODA_UPDATE_DOCAcción

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

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
titlestring
Title of the doc.
iconNamestring
Name of the icon.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update featured docs for a packCODA_UPDATE_FEATURED_DOCS_FOR_A_PACKAcción

Create or replace the featured docs for a pack.

Parámetros de entrada

itemsobject[]Obligatorio
A list of docs to set as the featured docs for a Pack.
packIdintegerObligatorio
ID of a Pack

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update packCODA_UPDATE_PACKAcción

Update an existing pack for non-versioned fields.

Parámetros de entrada

namestring
The name of the Pack.
packIdintegerObligatorio
ID of a Pack
descriptionstring
The full description of the Pack.
logoAssetIdstring
The asset id of the Pack"s logo, returned by [`#PackAssetUploadComplete`](#operation/packAssetUploadComplete) endpoint.
coverAssetIdstring
The asset id of the Pack"s cover image, returned by [`#PackAssetUploadComplete`](#operation/packAssetUploadComplete) endpoint.
supportEmailstring
A contact email for the Pack.
exampleImagesobject[]
The example images for the Pack.
privacyPolicyUrlstringurl
A Privacy Policy URL for the Pack.
shortDescriptionstring
A short version of the description of the Pack.
termsOfServiceUrlstringurl
A Terms of Service URL for the Pack.
sourceCodeVisibilitystringenum
Visibility of a pack"s source code.
privateshared
overallRateLimit__intervalSecondsinteger
The rate limit interval in seconds.
overallRateLimit__operationsPerIntervalinteger
The maximum number of Pack operations that can be performed in a given interval.
perConnectionRateLimit__intervalSecondsinteger
The rate limit interval in seconds.
perConnectionRateLimit__operationsPerIntervalinteger
The maximum number of Pack operations that can be performed in a given interval.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Updates a custom domainCODA_UPDATES_A_CUSTOM_DOMAINAcción

Updates properties of a document's custom domain.

Parámetros de entrada

docIdstringObligatorio
ID of the doc.
customDocDomainstringObligatorio
A custom domain for a published doc.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Updates user roleCODA_UPDATES_USER_ROLEAcción

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

Parámetros de entrada

emailstringObligatorio
Email of the user.
newRolestringObligatorioenum
Newrole
AdminDocMakerEditor
workspaceIdstringObligatorio
ID of the workspace.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload a pack assetCODA_UPLOAD_A_PACK_ASSETAcción

Request a signed s3 url to upload your pack asset.

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
filenamestringObligatorio
Filename
mimeTypestringObligatorio
The media type of the image being sent.
imageHashstringObligatorio
The SHA-256 hash of the image to be uploaded.
packAssetTypestringObligatorioenum
Packassettype
logocoverexampleImage

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload pack source codeCODA_UPLOAD_PACK_SOURCE_CODEAcción

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

Parámetros de entrada

packIdintegerObligatorio
ID of a Pack
filenamestringObligatorio
Filename
packVersionstring
Packversion
payloadHashstringObligatorio
The SHA-256 hash of the image to be uploaded.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Insert/Update Rows in Coda TableCODA_UPSERT_ROWSAcción

This tool allows you to insert new rows into a coda table or update existing ones based on specified key columns. this is particularly useful for synchronizing data or ensuring records are up-to-date without creating duplicates.

Parámetros de entrada

rowsobject[]Obligatorio
Array of row objects to insert or upsert.
doc_idstringObligatorio
ID of the doc containing the table.
key_columnsstring[]
Optional array of column IDs/names to use as upsert keys. If provided, existing rows matching these keys will be updated.
disable_parsingboolean
If true, the API will not attempt to parse the data in any way.
table_id_or_namestringObligatorio
ID or name of the table. Using table IDs is recommended to avoid issues if table names change.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Triggers (4)

Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).

Coda Document Deleted TriggerCODA_DOCUMENT_DELETEDTrigger

Triggers when a Coda document is deleted.

Configuración

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

Payload del evento

documentobjectObligatorio
The document that was deleted
event_typestringObligatorio
Type of event

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger will detect when Coda documents are deleted. - You can filter documents by owner, workspace, published status, and more. - The trigger will only detect deletions for documents that the authenticated user has access to. - Note: The trigger will establish a baseline of existing documents on first run and only report deletions thereafter.

New Coda Document TriggerCODA_NEW_CODA_DOCUMENTTrigger

Triggers when a new Coda document is created.

Configuración

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

Payload del evento

browserLinkstring
The browser link to the document
createdAtstring
The creation timestamp of the document
folderIdstring
The ID of the folder containing the document
hrefstring
The URL of the document
idstring
The ID of the document
namestring
The name of the document
ownerstring
The email of the document owner
ownerNamestring
The name of the document owner
typestring
The type of the document
updatedAtstring
The last update timestamp of the document
workspaceIdstring
The ID of the workspace containing the document

Instrucciones

**Instructions for Setting Up the Trigger:** - This trigger will detect new Coda documents as they are created. - You can filter documents by owner, workspace, published status, and more. - The trigger will only detect documents that the authenticated user has access to. - Note: The trigger will establish a baseline of existing documents on first run and only report new documents thereafter.

New Coda Page TriggerCODA_NEW_CODA_PAGETrigger

Triggers when a new page is added to a Coda document.

Configuración

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

Payload del evento

event_typestringObligatorio
Type of event
pageobjectObligatorio
The page that triggered the event

Instrucciones

**Instructions for Setting Up the Trigger:** - You need the Coda document ID (docId) to monitor for new pages. - The document ID can be found in the URL of your Coda document after "doc/". - Ensure you have proper access permissions to the document.

Specific Coda Page Updated TriggerCODA_SPECIFIC_CODA_PAGE_UPDATEDTrigger

Triggers when a specific page within a Coda document is updated.

Configuración

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

Payload del evento

event_typestringObligatorio
Type of event
pageobjectObligatorio
The page that was updated

Instrucciones

**Instructions for Setting Up the Trigger:** - You need the Coda document ID (docId) that contains the page to monitor. - You need the page ID or name (pageIdOrName) to monitor for updates. - The document ID can be found in the URL of your Coda document after "doc/". - The page ID can be found in the page's URL or via the Coda API. - If using a page name, be aware that if multiple pages have the same name, an arbitrary one will be selected. - Ensure you have proper access permissions to the document and page.