> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# coda-data
> Coda Data - tables, rows, columns, formulas, controls, analytics
**Server path:** `/coda-data` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------- | ------------------------------ |
| [`coda_data_change_user_role`](#coda_data_change_user_role) | Updates user role |
| [`coda_data_delete_row`](#coda_data_delete_row) | Delete row |
| [`coda_data_delete_rows`](#coda_data_delete_rows) | Delete multiple rows |
| [`coda_data_get_analytics_last_updated`](#coda_data_get_analytics_last_updated) | Get analytics last updated day |
| [`coda_data_get_column`](#coda_data_get_column) | Get a column |
| [`coda_data_get_control`](#coda_data_get_control) | Get a control |
| [`coda_data_get_formula`](#coda_data_get_formula) | Get a formula |
| [`coda_data_get_row`](#coda_data_get_row) | Get a row |
| [`coda_data_get_table`](#coda_data_get_table) | Get a table |
| [`coda_data_list_columns`](#coda_data_list_columns) | List columns |
| [`coda_data_list_controls`](#coda_data_list_controls) | List controls |
| [`coda_data_list_doc_analytics`](#coda_data_list_doc_analytics) | List doc analytics |
| [`coda_data_list_doc_analytics_summary`](#coda_data_list_doc_analytics_summary) | Get doc analytics summary |
| [`coda_data_list_formulas`](#coda_data_list_formulas) | List formulas |
| [`coda_data_list_page_analytics`](#coda_data_list_page_analytics) | List page analytics |
| [`coda_data_list_rows`](#coda_data_list_rows) | List table rows |
| [`coda_data_list_tables`](#coda_data_list_tables) | List tables |
| [`coda_data_list_workspace_members`](#coda_data_list_workspace_members) | List workspace users |
| [`coda_data_list_workspace_role_activity`](#coda_data_list_workspace_role_activity) | List workspace roles |
| [`coda_data_push_button`](#coda_data_push_button) | Push a button |
| [`coda_data_trigger_webhook_automation`](#coda_data_trigger_webhook_automation) | Trigger automation |
| [`coda_data_update_row`](#coda_data_update_row) | Update row |
| [`coda_data_upsert_rows`](#coda_data_upsert_rows) | Insert/upsert rows |
| [`coda_data_whoami`](#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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workspaceId": {
"type": "string",
"description": "ID of the workspace."
},
"email": {
"type": "string",
"description": "Email of the user."
},
"newRole": {
"type": "string",
"description": "New Role",
"enum": [
"Admin",
"DocMaker",
"Editor"
]
}
},
"required": [
"PCID",
"workspaceId",
"email",
"newRole"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"tableIdOrName": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"docId",
"tableIdOrName",
"rowIdOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"tableIdOrName": {
"type": "string",
"description": "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": {
"type": "array",
"items": {
"type": "string"
},
"description": "Row IDs to delete."
}
},
"required": [
"PCID",
"docId",
"tableIdOrName",
"rowIds"
]
}
```
***
## coda\_data\_get\_analytics\_last\_updated
Get analytics last updated day
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## coda\_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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"tableIdOrName": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"docId",
"tableIdOrName",
"columnIdOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"controlIdOrName": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"docId",
"controlIdOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"formulaIdOrName": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"docId",
"formulaIdOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"tableIdOrName": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "The format that cell values are returned as.",
"enum": [
"simple",
"simpleWithArrays",
"rich"
]
}
},
"required": [
"PCID",
"docId",
"tableIdOrName",
"rowIdOrName"
]
}
```
***
## 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) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"tableIdOrName": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "Return \"detail\" and \"form\" for the `layout` field of detail and form layouts respectively (instead of \"masterDetail\" for both)"
}
},
"required": [
"PCID",
"docId",
"tableIdOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"tableIdOrName": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "Maximum number of results to return in this query."
},
"pageToken": {
"type": "string",
"description": "An opaque token used to fetch the next page of results."
},
"visibleOnly": {
"type": "boolean",
"description": "If true, returns only visible columns for the table. This parameter only applies to base tables, and not views."
}
},
"required": [
"PCID",
"docId",
"tableIdOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return in this query."
},
"pageToken": {
"type": "string",
"description": "An opaque token used to fetch the next page of results."
},
"sortBy": {
"type": "string",
"description": "Determines how to sort the given objects.",
"enum": [
"name"
]
}
},
"required": [
"PCID",
"docId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of docIds to fetch."
},
"workspaceId": {
"type": "string",
"description": "ID of the workspace."
},
"query": {
"type": "string",
"description": "Search term used to filter down results."
},
"isPublished": {
"type": "boolean",
"description": "Limit results to only published items."
},
"sinceDate": {
"type": "string",
"description": "Limit results to activity on or after this date."
},
"untilDate": {
"type": "string",
"description": "Limit results to activity on or before this date."
},
"scale": {
"type": "string",
"description": "Quantization period over which to view analytics. Defaults to daily.",
"enum": [
"daily",
"cumulative"
]
},
"pageToken": {
"type": "string",
"description": "An opaque token used to fetch the next page of results."
},
"orderBy": {
"type": "string",
"description": "Use this parameter to order the doc analytics returned.",
"enum": [
"date",
"docId",
"title",
"createdAt",
"publishedAt",
"likes",
"copies",
"views",
"sessionsDesktop",
"sessionsMobile",
"sessionsOther",
"totalSessions",
"aiCreditsChat",
"aiCreditsBlock",
"aiCreditsColumn",
"aiCreditsAssistant",
"aiCreditsReviewer",
"aiCredits"
]
},
"direction": {
"type": "string",
"description": "Direction to sort results in.",
"enum": [
"ascending",
"descending"
]
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return in this query."
}
},
"required": [
"PCID"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"isPublished": {
"type": "boolean",
"description": "Limit results to only published items."
},
"sinceDate": {
"type": "string",
"description": "Limit results to activity on or after this date."
},
"untilDate": {
"type": "string",
"description": "Limit results to activity on or before this date."
},
"workspaceId": {
"type": "string",
"description": "ID of the workspace."
}
},
"required": [
"PCID"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return in this query."
},
"pageToken": {
"type": "string",
"description": "An opaque token used to fetch the next page of results."
},
"sortBy": {
"type": "string",
"description": "Determines how to sort the given objects.",
"enum": [
"name"
]
}
},
"required": [
"PCID",
"docId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"sinceDate": {
"type": "string",
"description": "Limit results to activity on or after this date."
},
"untilDate": {
"type": "string",
"description": "Limit results to activity on or before this date."
},
"pageToken": {
"type": "string",
"description": "An opaque token used to fetch the next page of results."
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return in this query."
}
},
"required": [
"PCID",
"docId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"tableIdOrName": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Query used to filter returned rows, specified as `:`. 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": {
"type": "string",
"description": "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.",
"enum": [
"createdAt",
"natural",
"updatedAt"
]
},
"useColumnNames": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "The format that cell values are returned as.",
"enum": [
"simple",
"simpleWithArrays",
"rich"
]
},
"visibleOnly": {
"type": "boolean",
"description": "If true, returns only visible rows and columns for the table."
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return in this query."
},
"pageToken": {
"type": "string",
"description": "An opaque token used to fetch the next page of results."
},
"syncToken": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"docId",
"tableIdOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return in this query."
},
"pageToken": {
"type": "string",
"description": "An opaque token used to fetch the next page of results."
},
"sortBy": {
"type": "string",
"description": "Determines how to sort the given objects.",
"enum": [
"name"
]
},
"tableTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"table",
"view"
]
},
"description": "Comma-separated list of table types to include in results. If omitted, includes both tables and views."
}
},
"required": [
"PCID",
"docId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workspaceId": {
"type": "string",
"description": "ID of the workspace."
},
"includedRoles": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Admin",
"DocMaker",
"Editor"
]
},
"description": "Show only the members that match the included roles. Multiple roles can be specified with a comma-delimited list."
},
"pageToken": {
"type": "string",
"description": "An opaque token used to fetch the next page of results."
}
},
"required": [
"PCID",
"workspaceId"
]
}
```
***
## coda\_data\_list\_workspace\_role\_activity
List workspace roles
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | -------------------- |
| `workspaceId` | string | Yes | — | ID of the workspace. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workspaceId": {
"type": "string",
"description": "ID of the workspace."
}
},
"required": [
"PCID",
"workspaceId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"tableIdOrName": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"docId",
"tableIdOrName",
"rowIdOrName",
"columnIdOrName"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"ruleId": {
"type": "string",
"description": "ID of the automation rule."
}
},
"required": [
"PCID",
"docId",
"ruleId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"tableIdOrName": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "If true, the API will not attempt to parse the data in any way."
},
"row": {
"type": "object",
"description": "An edit made to a particular row.",
"properties": {
"cells": {
"type": "array",
"items": {
"type": "object"
},
"description": "The cells value"
}
},
"required": [
"cells"
]
}
},
"required": [
"PCID",
"docId",
"tableIdOrName",
"rowIdOrName",
"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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"docId": {
"type": "string",
"description": "ID of the doc."
},
"tableIdOrName": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "If true, the API will not attempt to parse the data in any way."
},
"keyColumns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional column IDs, URLs, or names (fragile and discouraged), specifying columns to be used as upsert keys."
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string",
"description": "Column ID, URL, or name."
},
"value": {
"description": "The value to set."
}
}
},
"description": "The cells to edit in this row."
}
},
"required": [
"cells"
]
},
"description": "The rows value"
}
},
"required": [
"PCID",
"docId",
"tableIdOrName",
"rows"
]
}
```
***
## coda\_data\_whoami
Get user info
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```