/coda-data | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
coda_data_change_user_role | Updates user role |
coda_data_delete_row | Delete row |
coda_data_delete_rows | Delete multiple rows |
coda_data_get_analytics_last_updated | Get analytics last updated day |
coda_data_get_column | Get a column |
coda_data_get_control | Get a control |
coda_data_get_formula | Get a formula |
coda_data_get_row | Get a row |
coda_data_get_table | Get a table |
coda_data_list_columns | List columns |
coda_data_list_controls | List controls |
coda_data_list_doc_analytics | List doc analytics |
coda_data_list_doc_analytics_summary | Get doc analytics summary |
coda_data_list_formulas | List formulas |
coda_data_list_page_analytics | List page analytics |
coda_data_list_rows | List table rows |
coda_data_list_tables | List tables |
coda_data_list_workspace_members | List workspace users |
coda_data_list_workspace_role_activity | List workspace roles |
coda_data_push_button | Push a button |
coda_data_trigger_webhook_automation | Trigger automation |
coda_data_update_row | Update row |
coda_data_upsert_rows | Insert/upsert rows |
coda_data_whoami | Get user info |
coda_data_change_user_role
Updates user role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | ID of the workspace. |
email | string | Yes | — | Email of the user. |
newRole | string | Yes | — | New Role |
coda_data_delete_row
Delete row Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
tableIdOrName | string | Yes | — | 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. |
rowIdOrName | string | Yes | — | 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. |
coda_data_delete_rows
Delete multiple rows Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
tableIdOrName | string | Yes | — | 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. |
rowIds | string[] | Yes | — | Row IDs to delete. |
coda_data_get_analytics_last_updated
Get analytics last updated daycoda_data_get_column
Get a column Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
tableIdOrName | string | Yes | — | 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. |
columnIdOrName | string | Yes | — | 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. |
coda_data_get_control
Get a control Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
controlIdOrName | string | Yes | — | 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. |
coda_data_get_formula
Get a formula Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
formulaIdOrName | string | Yes | — | 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. |
coda_data_get_row
Get a row Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
tableIdOrName | string | Yes | — | 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. |
rowIdOrName | string | Yes | — | 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. |
useColumnNames | boolean | No | — | 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. |
valueFormat | string | No | — | The format that cell values are returned as. |
coda_data_get_table
Get a table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
tableIdOrName | string | Yes | — | 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. |
useUpdatedTableLayouts | boolean | No | — | Return “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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
tableIdOrName | string | Yes | — | 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. |
limit | integer | No | — | Maximum number of results to return in this query. |
pageToken | string | No | — | An opaque token used to fetch the next page of results. |
visibleOnly | boolean | No | — | If 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
limit | integer | No | — | Maximum number of results to return in this query. |
pageToken | string | No | — | An opaque token used to fetch the next page of results. |
sortBy | string | No | — | Determines how to sort the given objects. |
coda_data_list_doc_analytics
List doc analytics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docIds | string[] | No | — | List of docIds to fetch. |
workspaceId | string | No | — | ID of the workspace. |
query | string | No | — | Search term used to filter down results. |
isPublished | boolean | No | — | Limit results to only published items. |
sinceDate | string | No | — | Limit results to activity on or after this date. |
untilDate | string | No | — | Limit results to activity on or before this date. |
scale | string | No | — | Quantization period over which to view analytics. Defaults to daily. |
pageToken | string | No | — | An opaque token used to fetch the next page of results. |
orderBy | string | No | — | Use this parameter to order the doc analytics returned. |
direction | string | No | — | Direction to sort results in. |
limit | integer | No | — | Maximum number of results to return in this query. |
coda_data_list_doc_analytics_summary
Get doc analytics summary Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
isPublished | boolean | No | — | Limit results to only published items. |
sinceDate | string | No | — | Limit results to activity on or after this date. |
untilDate | string | No | — | Limit results to activity on or before this date. |
workspaceId | string | No | — | ID of the workspace. |
coda_data_list_formulas
List formulas Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
limit | integer | No | — | Maximum number of results to return in this query. |
pageToken | string | No | — | An opaque token used to fetch the next page of results. |
sortBy | string | No | — | Determines how to sort the given objects. |
coda_data_list_page_analytics
List page analytics Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
sinceDate | string | No | — | Limit results to activity on or after this date. |
untilDate | string | No | — | Limit results to activity on or before this date. |
pageToken | string | No | — | An opaque token used to fetch the next page of results. |
limit | integer | No | — | Maximum number of results to return in this query. |
coda_data_list_rows
List table rows Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
tableIdOrName | string | Yes | — | 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. |
query | string | No | — | 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"). |
sortBy | string | No | — | 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. |
useColumnNames | boolean | No | — | 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. |
valueFormat | string | No | — | The format that cell values are returned as. |
visibleOnly | boolean | No | — | If true, returns only visible rows and columns for the table. |
limit | integer | No | — | Maximum number of results to return in this query. |
pageToken | string | No | — | An opaque token used to fetch the next page of results. |
syncToken | string | No | — | 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. |
coda_data_list_tables
List tables Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
limit | integer | No | — | Maximum number of results to return in this query. |
pageToken | string | No | — | An opaque token used to fetch the next page of results. |
sortBy | string | No | — | Determines how to sort the given objects. |
tableTypes | string[] | No | — | Comma-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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | ID of the workspace. |
includedRoles | string[] | No | — | Show only the members that match the included roles. Multiple roles can be specified with a comma-delimited list. |
pageToken | string | No | — | An opaque token used to fetch the next page of results. |
coda_data_list_workspace_role_activity
List workspace roles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | Yes | — | ID of the workspace. |
coda_data_push_button
Push a button Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
tableIdOrName | string | Yes | — | 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. |
rowIdOrName | string | Yes | — | 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. |
columnIdOrName | string | Yes | — | 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. |
coda_data_trigger_webhook_automation
Trigger automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
ruleId | string | Yes | — | ID of the automation rule. |
coda_data_update_row
Update row Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
tableIdOrName | string | Yes | — | 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. |
rowIdOrName | string | Yes | — | 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. |
disableParsing | boolean | No | — | If true, the API will not attempt to parse the data in any way. |
row | object | Yes | — | An edit made to a particular row. |
coda_data_upsert_rows
Insert/upsert rows Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
docId | string | Yes | — | ID of the doc. |
tableIdOrName | string | Yes | — | 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. |
disableParsing | boolean | No | — | If true, the API will not attempt to parse the data in any way. |
keyColumns | string[] | No | — | Optional column IDs, URLs, or names (fragile and discouraged), specifying columns to be used as upsert keys. |
rows | object[] | Yes | — | The rows value |

