Coda Columns API
While columns in Coda have user-friendly names, they also have immutable IDs that are used when reading and writing rows. These endpoints let you query the columns in a table and get basic information about them.
OpenAPI Specification
openapi: 3.0.0
info:
version: 1.5.0
title: Coda Account Columns API
license:
name: Coda Developer Terms
url: https://coda.io/trust/developer
description: "# Introduction\n\nThe Coda API is a RESTful API that lets you programmatically interact with Coda docs:\n\n * List and search Coda docs\n * Create new docs and copy existing ones\n * Share and publish docs\n * Discover pages, tables, formulas, and controls\n * Read, insert, upsert, update, and delete rows\n\nIf you plan to integrate Coda with an AI tool, you may also want to consider using the\n[Coda MCP server](https://coda.io/resources/guides/getting_started_with_coda_mcp). It's optimized for LLM usage\npatterns and often exposes more granular methods for accessing and modifying data.\n\n# Getting Started\n\nOur [Getting Started Guide](https://coda.io/@oleg/getting-started-guide-coda-api) helps you learn the\nbasic of working with the API and shows a few ways you can use it. Check it out, and learn how to:\n\n- Read data from Coda tables and write back to them\n- Build a one-way sync from one Coda doc to another\n- Automate reminders\n- Sync your Google Calendar to Coda\n\n# Changes to the API\n\nAs we update and release newer versions of the API, we reserve the right to remove\nolder APIs and functionality with a 3-month deprecation notice. We will post about such changes as well as announce\nnew features in the [Developers Central](https://community.coda.io/c/developers-central) section of our Community,\nand update the [API updates](https://coda.io/api-updates) doc.\n\n# Using the API\n\nCoda's REST API is designed to be straightforward to use. You can use the language and platform of your choice to\nmake requests. To get a feel for the API, you can also use a tool like [Postman](https://www.getpostman.com/) or\n[Insomnia](https://insomnia.rest/).\n\n## API Endpoint\n\nThis API uses a base path of `https://coda.io/apis/v1`.\n\n## Resource IDs and Links\n\nEach resource instance retrieved via the API has the following fields:\n\n - `id`: The resource's immutable ID, which can be used to refer to it within its context\n - `type`: The type of resource, useful for identifying it in a heterogenous collection of results\n - `href`: A fully qualified URI that can be used to refer to and get the latest details on the resource\n\nMost resources can be queried by their name or ID. We recommend sticking with IDs where possible, as names are\nfragile and prone to being changed by your doc's users.\n\n### List Endpoints\n\nEndpoints supporting listing of resources have the following fields:\n\n - `items`: An array containing the listed resources, limited by the `limit` or `pageToken` query parameters\n - `nextPageLink`: If more results are available, an API link to the next page of results\n - `nextPageToken`: If more results are available, a page token that can be passed into the `pageToken` query parameter\n\n**The maximum page size may change at any time, and may be different for different endpoints.** Please do not rely on it\nfor any behavior of your application. If you pass a `limit` parameter that is larger than our maximum allowed limit,\nwe will only return as many results as our maximum limit. You should look for the presence of the `nextPageToken` on the\nresponse to see if there are more results available, rather than relying on a result set that matches your provided limit.\n\nTo fetch a subsequent page of results, pass the `pageToken` parameter. Set this parameter to the value given to you as the `nextPageToken`\nin a page response. If no value is provided, there are no more results available. You only need to pass the `pageToken` to get\nthe next page of results, you don't need to pass any of the parameters from your original request, as they are all\nimplied by the `pageToken`. Any other parameters provided alongside a `pageToken` will be ignored.\n\n### Doc IDs\n\nWhile most object IDs will have to be discovered via the API, you may find yourself frequently wanting to get the\nID of a specific Coda doc.\n\nHere's a handy tool that will extract it for you. (See if you can find the pattern!)\n\n<form>\n <fieldset style=\"margin: 0px 25px 25px 25px; display: inline;\">\n <legend>Doc ID Extractor</legend>\n <input type=\"text\" id=\"de_docUrl\" placeholder=\"Paste in a Coda doc URL\"\n style=\"width: 250px; padding: 8px; margin-right: 20px;\" />\n <span>\n Your doc ID is: \n <input id=\"de_docId\" readonly=\"true\"\n style=\"width: 150px; padding: 8px; font-family: monospace; border: 1px dashed gray;\" />\n </fieldset>\n</form>\n\n## Rate Limiting\n\nThe Coda API sets a reasonable limit on the number of requests that can be made per minute. Once this limit is\nreached, calls to the API will start returning errors with an HTTP status code of 429.\n\nThese are the current rate limits. They are subject to change at any time without notice. For robustness,\nall API scripts should check for HTTP 429 Too Many Requests errors and back off and retry the request.\nLimits apply per-user across all endpoints that share the same limit and across all docs.\n\nReading data (with the exceptions below): {{READ_RATE_LIMIT}}\n<br/>\nWriting data (POST/PUT/PATCH): {{WRITE_RATE_LIMIT}}\n<br/>\nWriting doc content data (POST/PUT/PATCH): {{WRITE_DOC_CONTENT_RATE_LIMIT}}\n<br/>\nListing docs: {{LIST_DOCS_RATE_LIMIT}}\n<br/>\nReading analytics: {{ANALYTICS_RATE_LIMIT}}\n\n## Consistency\n\nWhile edits made in Coda are shared with other collaborators in real-time, it can take a few seconds for them to\nbecome available via the API. You may also notice that changes made via the API, such as updating a row, are not\nimmediate. These endpoints all return an HTTP 202 status code, instead of a standard 200, indicating that the\nedit has been accepted and queued for processing. This generally takes a few seconds, and the edit may fail if\ninvalid. Each such edit will return a `requestId` in the response, and you can pass this `requestId` to the\n[`#getMutationStatus`](#operation/getMutationStatus) endpoint to find out if it has been applied.\n\nSimilarly, when you get doc data from the API (rows, pages, columns, etc), the data you receive comes from\nthe most recent \"snapshot\" of the doc, which might be slightly stale relative to the data you observe in\nyour browser. If you want to ensure that the data you receive is up to date and are ok getting an error if not,\nyou can pass this header in your request: `X-Coda-Doc-Version: latest`. If the API's view of the doc is\nnot up to date, the API will return an HTTP 400 response.\n\n## Volatile Formulas\n\nCoda exposes a number of \"volatile\" formulas, as as `Today()`, `Now()`, and `User()`. When used in a live Coda\ndoc, these formulas affect what's visible in realtime, tailored to the current user.\n\nSuch formulas behave differently with the API. Time-based values may only be current to the last edit made to the\ndoc. User-based values may be blank or invalid.\n\n## Free and Paid Workspaces\n\nWe make the Coda API available to all of our users free of charge, in both free and paid workspaces. However, API\nusage is subject to the role of the user associated with the API token in the workspace applicable to each API\nrequest. What this means is:\n\n- For the [`#createDoc`](#operation/createDoc) endpoint specifically, the owner of the API token must be a Doc\n Maker (or Admin) in the workspace. If the \"Any member can create docs\" option in enabled in the workspace\n settings, they can be an Editor and will get auto-promoted to Doc Maker upon using this endpoint. Lastly, if in\n addition, the API key owner matches the \"Auto-join email domains\" setting, they will be auto-added to the\n workspace and promoted to Doc Maker upon using this endpoint\n\nThis behavior applies to the API as well as any integrations that may use it, such as Zapier.\n\n## Examples\n\nTo help you get started, this documentation provides code examples in Python, Unix shell, and Google Apps Script.\nThese examples are based on a simple doc that looks something like this:\n\n\n\n### Python examples\n\nThese examples use Python 3.6+. If you don't already have the `requests` module, use `pip` or `easy_install` to\nget it.\n\n### Shell examples\n\nThe shell examples are intended to be run in a Unix shell. If you're on Windows, you will need to install\n[WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).\n\nThese examples use the standard cURL utility to pull from the API, and then process it with `jq` to extract and\nformat example output. If you don't already have it, you can either [install it](https://stedolan.github.io/jq/)\nor run the command without it to see the raw JSON output.\n\n### Google Apps Script examples\n\n\n\n[Google Apps Script](https://script.google.com/) makes it easy to write code in a JavaScript-like syntax and\neasily access many Google products with built-in libraries. You can set up your scripts to run periodically,\nwhich makes it a good environment for writing tools without maintaining your own server.\n\nCoda provides a library for Google Apps Script. To use it, go into `Resources -> Libraries...` and enter the\nfollowing library ID: `15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl`. If you want to see the\nlibrary's source code, it's available\n[here](https://script.google.com/d/15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl/edit).\n\nGoogle provides autocomplete for API functions as well as generated docs. You can access these docs via the\nLibraries dialog by clicking on the library name. Required parameters that would be included in the URL path are\npositional arguments in each of these functions, followed by the request body, if applicable. All remaining\nparameters can be specified in the options object.\n\n## OpenAPI/Swagger Spec\n\nIn an effort to standardize our API and make it accessible, we offer an OpenAPI 3.0 specification:\n\n- [OpenAPI 3.0 spec - YAML](https://coda.io/apis/v1/openapi.yaml)\n- [OpenAPI 3.0 spec - JSON](https://coda.io/apis/v1/openapi.json)\n\n#### Postman collection\n\nTo get started with prototyping the API quickly in Postman, you can use one of links above to import the Coda API\ninto a collection. You'll then need to set the [appropriate header](#section/Authentication) and environment\nvariables.\n\n## Client libraries\n\nWe do not currently support client libraries apart from Google Apps Script. To work with the Coda API, you can\neither use standard network libraries for your language, or use the appropriate Swagger Generator tool to\nauto-generate Coda API client libraries for your language of choice. We do not provide any guarantees that these\nautogenerated libraries are compatible with our API (e.g., some libraries may not work with Bearer\nauthentication).\n\n### OpenAPI 3.0\n\n[Swagger Generator 3](https://generator3.swagger.io/) (that link takes you to the docs for the generator API) can\ngenerate client libraries for [these languages](https://generator3.swagger.io/v2/clients). It's relatively new\nand thus only has support for a limited set of languages at this time.\n\n### Third-party client libraries\n\nSome members of our amazing community have written libraries to work with our API. These aren't officially\nsupported by Coda, but are listed here for convenience. (Please let us know if you've written a library and would\nlike to have it included here.)\n\n- [PHP](https://github.com/danielstieber/CodaPHP) by Daniel Stieber\n- [Node-RED](https://github.com/serene-water/node-red-contrib-coda-io) by Mori Sugimoto\n- [NodeJS](https://www.npmjs.com/package/coda-js) by Parker McMullin\n- [Ruby](https://rubygems.org/gems/coda_docs/) by Carlos Muñoz at Getro\n- [Python](https://github.com/Blasterai/codaio) by Mikhail Beliansky\n- [Go](https://github.com/artsafin/coda-schema-generator) by Artur Safin\n"
termsOfService: https://coda.io/trust/tos
contact:
name: API Support
url: https://coda.io
email: help+api@coda.io
x-logo:
url: https://cdn.coda.io/external/img/apilogo.png
backgroundColor: transparent
altText: Coda API
href: '#'
servers:
- url: https://coda.io/apis/v1
description: Coda API (v1)
security:
- Bearer: []
tags:
- name: Columns
description: 'While columns in Coda have user-friendly names, they also have immutable IDs that are used when reading and writing rows. These endpoints let you query the columns in a table and get basic information about them.
'
paths:
/docs/{docId}/tables/{tableIdOrName}/columns:
get:
summary: List columns
description: Returns a list of columns in a table.
operationId: listColumns
tags:
- Columns
parameters:
- $ref: '#/components/parameters/docId'
- $ref: '#/components/parameters/tableIdOrName'
- name: limit
description: Maximum number of results to return in this query.
in: query
example: 10
schema:
type: integer
minimum: 1
maximum: 100
default: 25
- $ref: '#/components/parameters/pageToken'
- name: visibleOnly
description: If true, returns only visible columns for the table. This parameter only applies to base tables, and not views.
in: query
example: true
schema:
type: boolean
responses:
'200':
description: List of columns in the table.
content:
application/json:
schema:
$ref: '#/components/schemas/ColumnList'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFoundError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
x-codeSamples:
- label: Python 3.13
lang: python
source: 'import requests
headers = {''Authorization'': ''Bearer <your API token>''}
uri = f''https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/columns''
res = requests.get(uri, headers=headers).json()
print(f''This table\''s columns: {", ".join(c["name"] for c in res["items"])}'')
# => This table''s columns: Task, Duration (hr), Duration (min)
'
- label: Shell
lang: shell
source: "curl -s -H 'Authorization: Bearer <your API token>' \\\n 'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/columns' |\n jq '.items | map(.name) | join(\", \")'\n# => \"Task, Duration (hr), Duration (min)\"\n"
- label: Google Apps Script
lang: javascript
source: '// Import the CodaAPI library via Resource->Libraries...:
// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
CodaAPI.authenticate(''<your API token>'');
var columns = CodaAPI.listColumns(''<doc ID>'', ''<table ID>'').items;
var names = columns.map(function(column) { return column.name; });
Logger.log(''This table\''s columns: '' + names.join('', ''));
// => This table''s columns: Task, Duration (hr), Duration (min)
'
/docs/{docId}/tables/{tableIdOrName}/columns/{columnIdOrName}:
get:
summary: Get a column
description: Returns details about a column in a table.
operationId: getColumn
tags:
- Columns
parameters:
- $ref: '#/components/parameters/docId'
- $ref: '#/components/parameters/tableIdOrName'
- $ref: '#/components/parameters/columnIdOrName'
responses:
'200':
description: Info about a column.
content:
application/json:
schema:
$ref: '#/components/schemas/ColumnDetail'
'401':
$ref: '#/components/responses/UnauthorizedError'
'403':
$ref: '#/components/responses/ForbiddenError'
'404':
$ref: '#/components/responses/NotFoundError'
'429':
$ref: '#/components/responses/TooManyRequestsError'
x-codeSamples:
- label: Python 3.13
lang: python
source: 'import requests
headers = {''Authorization'': ''Bearer <your API token>''}
uri = f''https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/columns/<column ID>''
res = requests.get(uri, headers=headers).json()
is_default = res.get("display", False)
print(f''Column {res["name"]} {"is" if is_default else "is not"} the display column'')
# => Column Task is the display column
'
- label: Shell
lang: shell
source: "curl -s -H 'Authorization: Bearer <your API token>' \\\n 'https://coda.io/apis/v1/docs/<doc ID>/tables/<table ID>/columns/<column ID>' |\n jq '\"Column \" + .name + (if .display then \" is\" else \" is not\" end) + \" the display column\"'\n# => \"Column Task is the display column\"\n"
- label: Google Apps Script
lang: javascript
source: '// Import the CodaAPI library via Resource->Libraries...:
// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl
CodaAPI.authenticate(''<your API token>'');
var column = CodaAPI.getColumn(''<doc ID>'', ''<table ID>'', ''<column ID>'');
Logger.log(''Column '' + column.name + (column.display ? '' is'' : '' is not'') + '' the display column'');
# => Column Task is the display column
'
components:
schemas:
CheckboxDisplayType:
x-schema-name: CheckboxDisplayType
description: How a checkbox should be displayed.
type: string
enum:
- toggle
- check
x-tsEnumNames:
- Toggle
- Check
EmailDisplayType:
x-schema-name: EmailDisplayType
description: How an email address should be displayed in the user interface.
type: string
enum:
- iconAndEmail
- iconOnly
- emailOnly
x-tsEnumNames:
- IconAndEmail
- IconOnly
- EmailOnly
CurrencyFormatType:
x-schema-name: CurrencyFormatType
description: How the numeric value should be formatted (with or without symbol, negative numbers in parens).
type: string
enum:
- currency
- accounting
- financial
x-tsEnumNames:
- Currency
- Accounting
- Financial
SimpleColumnFormat:
x-schema-name: SimpleColumnFormat
description: Format of a simple column.
type: object
required:
- type
- isArray
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/ColumnFormatType'
isArray:
type: boolean
description: Whether or not this column is an array.
example: true
EmailColumnFormat:
x-schema-name: EmailColumnFormat
description: Format of an email column.
allOf:
- $ref: '#/components/schemas/SimpleColumnFormat'
- type: object
additionalProperties: false
properties:
display:
$ref: '#/components/schemas/EmailDisplayType'
autocomplete:
type: boolean
ScaleColumnFormat:
x-schema-name: ScaleColumnFormat
description: Format of a numeric column that renders as a scale, like star ratings.
allOf:
- $ref: '#/components/schemas/SimpleColumnFormat'
- type: object
additionalProperties: false
required:
- maximum
- icon
properties:
maximum:
type: number
description: The maximum number allowed for this scale.
example: 5
icon:
allOf:
- description: The icon set to use when rendering the scale, e.g. render a 5 star scale.
additionalProperties: false
- $ref: '#/components/schemas/IconSet'
ColumnFormat:
x-schema-name: ColumnFormat
description: Format of a column.
oneOf:
- $ref: '#/components/schemas/ButtonColumnFormat'
- $ref: '#/components/schemas/CheckboxColumnFormat'
- $ref: '#/components/schemas/DateColumnFormat'
- $ref: '#/components/schemas/DateTimeColumnFormat'
- $ref: '#/components/schemas/DurationColumnFormat'
- $ref: '#/components/schemas/EmailColumnFormat'
- $ref: '#/components/schemas/LinkColumnFormat'
- $ref: '#/components/schemas/CurrencyColumnFormat'
- $ref: '#/components/schemas/ImageReferenceColumnFormat'
- $ref: '#/components/schemas/NumericColumnFormat'
- $ref: '#/components/schemas/ReferenceColumnFormat'
- $ref: '#/components/schemas/SelectColumnFormat'
- $ref: '#/components/schemas/SimpleColumnFormat'
- $ref: '#/components/schemas/ScaleColumnFormat'
- $ref: '#/components/schemas/SliderColumnFormat'
- $ref: '#/components/schemas/TimeColumnFormat'
discriminator:
propertyName: type
mapping:
text: '#/components/schemas/SimpleColumnFormat'
person: '#/components/schemas/ReferenceColumnFormat'
lookup: '#/components/schemas/ReferenceColumnFormat'
number: '#/components/schemas/NumericColumnFormat'
percent: '#/components/schemas/NumericColumnFormat'
currency: '#/components/schemas/CurrencyColumnFormat'
date: '#/components/schemas/DateColumnFormat'
dateTime: '#/components/schemas/DateTimeColumnFormat'
time: '#/components/schemas/TimeColumnFormat'
duration: '#/components/schemas/DurationColumnFormat'
slider: '#/components/schemas/SliderColumnFormat'
scale: '#/components/schemas/ScaleColumnFormat'
image: '#/components/schemas/SimpleColumnFormat'
imageReference: '#/components/schemas/ImageReferenceColumnFormat'
attachments: '#/components/schemas/SimpleColumnFormat'
button: '#/components/schemas/ButtonColumnFormat'
checkbox: '#/components/schemas/CheckboxColumnFormat'
select: '#/components/schemas/SelectColumnFormat'
packObject: '#/components/schemas/SimpleColumnFormat'
canvas: '#/components/schemas/SimpleColumnFormat'
other: '#/components/schemas/SimpleColumnFormat'
SliderColumnFormat:
x-schema-name: SliderColumnFormat
description: Format of a numeric column that renders as a slider.
allOf:
- $ref: '#/components/schemas/SimpleColumnFormat'
- type: object
additionalProperties: false
properties:
minimum:
allOf:
- description: The minimum allowed value for this slider.
additionalProperties: false
- $ref: '#/components/schemas/NumberOrNumberFormula'
maximum:
allOf:
- description: The maximum allowed value for this slider.
additionalProperties: false
- $ref: '#/components/schemas/NumberOrNumberFormula'
step:
allOf:
- description: The step size (numeric increment) for this slider.
additionalProperties: false
- $ref: '#/components/schemas/NumberOrNumberFormula'
displayType:
$ref: '#/components/schemas/SliderDisplayType'
showValue:
type: boolean
description: Whether the underyling numeric value is also displayed.
example: true
NumericColumnFormat:
x-schema-name: NumericColumnFormat
description: Format of a numeric column.
allOf:
- $ref: '#/components/schemas/SimpleColumnFormat'
- type: object
additionalProperties: false
properties:
precision:
type: integer
minimum: 0
maximum: 10
description: The decimal precision.
example: 2
useThousandsSeparator:
type: boolean
description: Whether to use a thousands separator (like ",") to format the numeric value.
example: true
DurationColumnFormat:
x-schema-name: DurationColumnFormat
description: Format of a duration column.
allOf:
- $ref: '#/components/schemas/SimpleColumnFormat'
- type: object
additionalProperties: false
properties:
precision:
type: integer
example: 2
maxUnit:
allOf:
- description: The maximum unit of precision, e.g. "hours" if this duration need not include minutes.
additionalProperties: false
- $ref: '#/components/schemas/DurationUnit'
nextPageToken:
description: If specified, an opaque token used to fetch the next page of results.
type: string
example: eyJsaW1pd
IconSet:
x-schema-name: IconSet
description: List of available icon sets.
type: string
enum:
- star
- circle
- fire
- bug
- diamond
- bell
- thumbsup
- heart
- chili
- smiley
- lightning
- currency
- coffee
- person
- battery
- cocktail
- cloud
- sun
- checkmark
- lightbulb
x-tsEnumNames:
- Star
- Circle
- Fire
- Bug
- Diamond
- Bell
- ThumbsUp
- Heart
- Chili
- Smiley
- Lightning
- Currency
- Coffee
- Person
- Battery
- Cocktail
- Cloud
- Sun
- Checkmark
- LightBulb
ImageShapeStyle:
x-schema-name: ImageShapeStyle
description: How an image should be displayed.
type: string
enum:
- auto
- circle
x-tsEnumNames:
- Auto
- Circle
TableType:
x-schema-name: TableType
type: string
enum:
- table
- view
x-tsEnumNames:
- Table
- View
LinkDisplayType:
x-schema-name: LinkDisplayType
description: How a link should be displayed in the user interface.
type: string
enum:
- iconOnly
- url
- title
- card
- embed
x-tsEnumNames:
- IconOnly
- Url
- Title
- Card
- Embed
DateTimeColumnFormat:
x-schema-name: DateTimeColumnFormat
description: Format of a date column.
allOf:
- $ref: '#/components/schemas/SimpleColumnFormat'
- type: object
additionalProperties: false
properties:
dateFormat:
type: string
description: 'A format string using Moment syntax: https://momentjs.com/docs/#/displaying/'
example: YYYY-MM-DD
timeFormat:
type: string
description: 'A format string using Moment syntax: https://momentjs.com/docs/#/displaying/'
example: h:mm:ss A
CurrencyColumnFormat:
x-schema-name: CurrencyColumnFormat
description: Format of a currency column.
allOf:
- $ref: '#/components/schemas/SimpleColumnFormat'
- type: object
additionalProperties: false
properties:
currencyCode:
type: string
description: The currency symbol
example: $
precision:
type: integer
minimum: 0
maximum: 10
description: The decimal precision.
example: 2
format:
$ref: '#/components/schemas/CurrencyFormatType'
ColumnFormatType:
x-schema-name: ColumnFormatType
description: Format type of the column
type: string
enum:
- text
- person
- lookup
- number
- percent
- currency
- date
- dateTime
- time
- duration
- email
- link
- slider
- scale
- image
- imageReference
- attachments
- button
- checkbox
- select
- packObject
- reaction
- canvas
- other
x-tsEnumNames:
- Text
- Person
- Lookup
- Number
- Percent
- Currency
- Date
- DateTime
- Time
- Duration
- Email
- Link
- Slider
- Scale
- Image
- ImageReference
- Attachments
- Button
- Checkbox
- Select
- PackObject
- Reaction
- Canvas
- Other
PageReference:
x-schema-name: PageReference
description: Reference to a page.
type: object
required:
- id
- type
- browserLink
- href
- name
additionalProperties: false
properties:
id:
type: string
description: ID of the page.
example: canvas-IjkLmnO
type:
type: string
description: The type of this resource.
enum:
- page
x-tsType: Type.Page
href:
type: string
format: url
description: API link to the page.
example: https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO
browserLink:
type: string
format: url
description: Browser-friendly link to the page.
example: https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO
name:
type: string
description: Name of the page.
example: Launch Status
NumberOrNumberFormula:
x-schema-name: NumberOrNumberFormula
description: A number or a string representing a formula that evaluates to a number.
oneOf:
- type: number
description: A numeric value.
example: 1
- type: string
description: A formula that evaluates to a numeric value.
example: 5 * 10
DateColumnFormat:
x-schema-name: DateColumnFormat
description: Format of a date column.
allOf:
- $ref: '#/components/schemas/SimpleColumnFormat'
- type: object
additionalProperties: false
properties:
format:
type: string
description: 'A format string using Moment syntax: https://momentjs.com/docs/#/displaying/'
example: YYYY-MM-DD
TableReference:
x-schema-name: TableReference
description: Reference to a table or view.
type: object
required:
- id
- type
- tableType
- browserLink
- href
- name
additionalProperties: false
properties:
id:
type: string
description: ID of the table.
example: grid-pqRst-U
type:
type: string
description: The type of this resource.
enum:
- table
x-tsType: Type.Table
tableType:
$ref: '#/components/schemas/TableType'
href:
type: string
format: url
description: API link to the table.
example: https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U
browserLink:
type: string
format: url
description: Browser-friendly link to the table.
example: https://coda.io/d/_dAbCDeFGH/#Teams-and-Tasks_tpqRst-U
name:
type: string
description: Name of the table.
example: Tasks
parent:
$ref: '#/components/schemas/PageReference'
DurationUnit:
x-schema-name: DurationUnit
description: A time unit used as part of a duration value.
type: string
enum:
- days
- hours
- minutes
- seconds
x-tsEnumNames:
- Days
- Hours
- Minutes
- Seconds
ReferenceColumnFormat:
x-schema-name: ReferenceColumnFormat
description: Format of a column that refers to another table.
allOf:
- $ref: '#/components/schemas/SimpleColumnFormat'
- type: object
additionalProperties: false
required:
- table
properties:
table:
allOf:
- description: Reference to the table this column refers to, if applicable.
additionalProperties: false
- $ref: '#/components/schemas/TableReference'
ImageReferenceColumnFormat:
x-schema-name: ImageReferenceColumnFormat
description: Format of an image reference column.
allOf:
- $ref: '#/components/schemas/SimpleColumnFormat'
- type: object
additionalProperties: false
required:
- width
- height
- style
properties:
width:
all
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coda/refs/heads/main/openapi/coda-columns-api-openapi.yml