Skip to main content
Server path: /coda-data | Type: Application | PCID required: Yes

Tools


coda_data_change_user_role

Updates user role Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesID of the workspace.
emailstringYesEmail of the user.
newRolestringYesNew Role

coda_data_delete_row

Delete row Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
tableIdOrNamestringYesID 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.
rowIdOrNamestringYesID 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.

coda_data_delete_rows

Delete multiple rows Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
tableIdOrNamestringYesID 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.
rowIdsstring[]YesRow IDs to delete.

coda_data_get_analytics_last_updated

Get analytics last updated day

coda_data_get_column

Get a column Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
tableIdOrNamestringYesID 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.
columnIdOrNamestringYesID 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.

coda_data_get_control

Get a control Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
controlIdOrNamestringYesID 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.

coda_data_get_formula

Get a formula Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
formulaIdOrNamestringYesID 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.

coda_data_get_row

Get a row Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
tableIdOrNamestringYesID 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.
rowIdOrNamestringYesID 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.
useColumnNamesbooleanNoUse 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.
valueFormatstringNoThe format that cell values are returned as.

coda_data_get_table

Get a table Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
tableIdOrNamestringYesID 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.
useUpdatedTableLayoutsbooleanNoReturn “detail” and “form” for the layout field of detail and form layouts respectively (instead of “masterDetail” for both)

coda_data_list_columns

List columns Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
tableIdOrNamestringYesID 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.
limitintegerNoMaximum number of results to return in this query.
pageTokenstringNoAn opaque token used to fetch the next page of results.
visibleOnlybooleanNoIf true, returns only visible columns for the table. This parameter only applies to base tables, and not views.

coda_data_list_controls

List controls Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
limitintegerNoMaximum number of results to return in this query.
pageTokenstringNoAn opaque token used to fetch the next page of results.
sortBystringNoDetermines how to sort the given objects.

coda_data_list_doc_analytics

List doc analytics Parameters:
ParameterTypeRequiredDefaultDescription
docIdsstring[]NoList of docIds to fetch.
workspaceIdstringNoID of the workspace.
querystringNoSearch term used to filter down results.
isPublishedbooleanNoLimit results to only published items.
sinceDatestringNoLimit results to activity on or after this date.
untilDatestringNoLimit results to activity on or before this date.
scalestringNoQuantization period over which to view analytics. Defaults to daily.
pageTokenstringNoAn opaque token used to fetch the next page of results.
orderBystringNoUse this parameter to order the doc analytics returned.
directionstringNoDirection to sort results in.
limitintegerNoMaximum number of results to return in this query.

coda_data_list_doc_analytics_summary

Get doc analytics summary Parameters:
ParameterTypeRequiredDefaultDescription
isPublishedbooleanNoLimit results to only published items.
sinceDatestringNoLimit results to activity on or after this date.
untilDatestringNoLimit results to activity on or before this date.
workspaceIdstringNoID of the workspace.

coda_data_list_formulas

List formulas Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
limitintegerNoMaximum number of results to return in this query.
pageTokenstringNoAn opaque token used to fetch the next page of results.
sortBystringNoDetermines how to sort the given objects.

coda_data_list_page_analytics

List page analytics Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
sinceDatestringNoLimit results to activity on or after this date.
untilDatestringNoLimit results to activity on or before this date.
pageTokenstringNoAn opaque token used to fetch the next page of results.
limitintegerNoMaximum number of results to return in this query.

coda_data_list_rows

List table rows Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
tableIdOrNamestringYesID 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.
querystringNoQuery 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").
sortBystringNoSpecifies 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.
useColumnNamesbooleanNoUse 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.
valueFormatstringNoThe format that cell values are returned as.
visibleOnlybooleanNoIf true, returns only visible rows and columns for the table.
limitintegerNoMaximum number of results to return in this query.
pageTokenstringNoAn opaque token used to fetch the next page of results.
syncTokenstringNoAn 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.

coda_data_list_tables

List tables Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
limitintegerNoMaximum number of results to return in this query.
pageTokenstringNoAn opaque token used to fetch the next page of results.
sortBystringNoDetermines how to sort the given objects.
tableTypesstring[]NoComma-separated list of table types to include in results. If omitted, includes both tables and views.

coda_data_list_workspace_members

List workspace users Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesID of the workspace.
includedRolesstring[]NoShow only the members that match the included roles. Multiple roles can be specified with a comma-delimited list.
pageTokenstringNoAn opaque token used to fetch the next page of results.

coda_data_list_workspace_role_activity

List workspace roles Parameters:
ParameterTypeRequiredDefaultDescription
workspaceIdstringYesID of the workspace.

coda_data_push_button

Push a button Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
tableIdOrNamestringYesID 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.
rowIdOrNamestringYesID 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.
columnIdOrNamestringYesID 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.

coda_data_trigger_webhook_automation

Trigger automation Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
ruleIdstringYesID of the automation rule.

coda_data_update_row

Update row Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
tableIdOrNamestringYesID 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.
rowIdOrNamestringYesID 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.
disableParsingbooleanNoIf true, the API will not attempt to parse the data in any way.
rowobjectYesAn edit made to a particular row.

coda_data_upsert_rows

Insert/upsert rows Parameters:
ParameterTypeRequiredDefaultDescription
docIdstringYesID of the doc.
tableIdOrNamestringYesID 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.
disableParsingbooleanNoIf true, the API will not attempt to parse the data in any way.
keyColumnsstring[]NoOptional column IDs, URLs, or names (fragile and discouraged), specifying columns to be used as upsert keys.
rowsobject[]YesThe rows value

coda_data_whoami

Get user info