openapi: 3.0.0 info: version: 1.5.0 title: Coda Account Pages 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
\n
\n Doc ID Extractor\n \n \n Your doc ID is:   \n \n
\n
\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
\nWriting data (POST/PUT/PATCH): {{WRITE_RATE_LIMIT}}\n
\nWriting doc content data (POST/PUT/PATCH): {{WRITE_DOC_CONTENT_RATE_LIMIT}}\n
\nListing docs: {{LIST_DOCS_RATE_LIMIT}}\n
\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![](https://cdn.coda.io/external/img/api_example_doc.png)\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![](https://cdn.coda.io/external/img/api_gas.png)\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: Pages description: 'Pages in Coda offer canvases containing rich text, tables, controls, and other objects. At this time, this API lets you list and access pages in a doc. ' paths: /docs/{docId}/pages: get: summary: List pages description: Returns a list of pages in a Coda doc. operationId: listPages tags: - Pages parameters: - $ref: '#/components/parameters/docId' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/pageToken' responses: '200': description: List of pages. content: application/json: schema: $ref: '#/components/schemas/PageList' '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 ''} uri = f''https://coda.io/apis/v1/docs//pages'' res = requests.get(uri, headers=headers).json() print(f''The name of the first page is {res["items"][0]["name"]}'') # => The name of the first page is Page 1 ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//pages' |\n jq '.items[0].name'\n# => \"Page 1\"\n" - label: Google Apps Script lang: javascript source: '// Import the CodaAPI library via Resource->Libraries...: // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl CodaAPI.authenticate(''''); var pages = CodaAPI.listPages('''').items; Logger.log(''The name of the first page is '' + pages[0].name); // => The name of the first page is Page 1 ' post: summary: Create a page description: 'Create a new page in a doc. Note that creating a page requires you to be a Doc Maker in the applicable workspace. ' operationId: createPage tags: - Pages parameters: - $ref: '#/components/parameters/docId' requestBody: description: Parameters for creating a page. required: true content: application/json: schema: $ref: '#/components/schemas/PageCreate' responses: '202': description: A result indicating that the creation request was queued for processing. content: application/json: schema: $ref: '#/components/schemas/PageCreateResult' '400': $ref: '#/components/responses/BadRequestError' '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\n\nheaders = {'Authorization': 'Bearer '}\nuri = f'https://coda.io/apis/v1/docs//pages'\npayload = {\n 'name': 'New Page Name',\n}\nreq = requests.post(uri, headers=headers, json=payload)\nreq.raise_for_status() # Throw if there was an error.\nres = req.json()\n\nprint(f'Created page {res[\"id\"]}')\n# => Created page \n" - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' -X POST -H \"Content-Type: application/json\" \\\n -d '{\"name\": \"New Page Name\"}' \\\n 'https://coda.io/apis/v1/docs//pages' |\n jq '\"Created page \" + .id'\n# => \"Created page \"\n" - label: Google Apps Script lang: javascript source: '// Import the CodaAPI library via Resource->Libraries...: // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl CodaAPI.authenticate(''''); var res = CodaAPI.createPage(, {name: "New Page Name"}); Logger.log(''Created page '' + res.id); // => Created page ' /docs/{docId}/pages/{pageIdOrName}: get: summary: Get a page description: Returns details about a page. operationId: getPage tags: - Pages parameters: - $ref: '#/components/parameters/docId' - $ref: '#/components/parameters/pageIdOrName' responses: '200': description: Info about a page. content: application/json: schema: $ref: '#/components/schemas/Page' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '410': $ref: '#/components/responses/GoneError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = f''https://coda.io/apis/v1/docs//pages/'' res = requests.get(uri, headers=headers).json() print(f''The name of this page is {res["name"]}'') # => The name of this page is Page 1 ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//pages/' |\n jq '.name'\n# => \"Page 1\"\n" - label: Google Apps Script lang: javascript source: '// Import the CodaAPI library via Resource->Libraries...: // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl CodaAPI.authenticate(''''); var page = CodaAPI.getPage('''', ''''); Logger.log(''The name of this page is '' + page.name); // => The name of this page is Page 1 ' put: summary: Update a page description: 'Update properties for a page. Note that updating a page title or icon requires you to be a Doc Maker in the applicable workspace. ' operationId: updatePage tags: - Pages parameters: - $ref: '#/components/parameters/docId' - $ref: '#/components/parameters/pageIdOrName' requestBody: description: Parameters for updating a page. required: true content: application/json: schema: $ref: '#/components/schemas/PageUpdate' responses: '202': description: A result indicating that the update was queued for processing. content: application/json: schema: $ref: '#/components/schemas/PageUpdateResult' '400': $ref: '#/components/responses/BadRequestError' '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\n\nheaders = {'Authorization': 'Bearer '}\nuri = f'https://coda.io/apis/v1/docs//pages/'\npayload = {\n 'name': 'New Page Name',\n}\nreq = requests.put(uri, headers=headers, json=payload)\nreq.raise_for_status() # Throw if there was an error.\nres = req.json()\n\nprint(f'Updated page {res[\"id\"]}')\n# => Updated page \n" - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' -X PUT -H \"Content-Type: application/json\" \\\n -d '{\"name\": \"New Page Name\"}' \\\n 'https://coda.io/apis/v1/docs//pages/' |\n jq '\"Updated page \" + .id'\n# => \"Updated page \"\n" - label: Google Apps Script lang: javascript source: '// Import the CodaAPI library via Resource->Libraries...: // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl CodaAPI.authenticate(''''); var res = CodaAPI.updatePage(, , {name: "New Page Name"}); Logger.log(''Updated page '' + res.id); // => Updated page ' delete: summary: Delete a page description: Deletes the specified page. operationId: deletePage tags: - Pages parameters: - $ref: '#/components/parameters/docId' - $ref: '#/components/parameters/pageIdOrName' responses: '202': description: A result indicating that the delete was queued for processing. content: application/json: schema: $ref: '#/components/schemas/PageDeleteResult' '400': $ref: '#/components/responses/BadRequestError' '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 ''} uri = f''https://coda.io/apis/v1/docs//pages/'' req = requests.delete(uri, headers=headers) req.raise_for_status() # Throw if there was an error. res = req.json() print(f''Deleted page'') # => Deleted page ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' -X DELETE -H \"Content-Type: application/json\" \\\n 'https://coda.io/apis/v1/docs//pages/' |\n jq 'if .statusMessage? == null then \"Deleted page\" else . end'\n# => \"Deleted pages\"\n" - label: Google Apps Script lang: javascript source: '// Import the CodaAPI library via Resource->Libraries...: // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl CodaAPI.authenticate(''''); CodaAPI.deleteRows('''', ''''); Logger.log(''Deleted 2 rows''); // => Deleted page ' /docs/{docId}/pages/{pageIdOrName}/content: get: summary: List page content description: Returns a list of content elements in a page. operationId: listPageContent tags: - Pages parameters: - $ref: '#/components/parameters/docId' - $ref: '#/components/parameters/pageIdOrName' - $ref: '#/components/parameters/pageContentLimit' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/contentFormat' responses: '200': description: List of page content elements. content: application/json: schema: $ref: '#/components/schemas/PageContentList' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '410': $ref: '#/components/responses/GoneError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = f''https://coda.io/apis/v1/docs//pages//content'' res = requests.get(uri, headers=headers).json() print(f''The page has {len(res["items"])} content elements'') # => The page has 10 content elements ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//pages//content' |\n jq '.items | length'\n# => 10\n" - label: Google Apps Script lang: javascript source: '// Import the CodaAPI library via Resource->Libraries...: // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl CodaAPI.authenticate(''''); var content = CodaAPI.listPageContent('''', ''''); Logger.log(''The page has '' + content.items.length + '' content elements''); // => The page has 10 content elements ' delete: summary: Delete page content description: 'Delete content from a page. You can delete specific elements by providing their IDs, or delete all content from the page. ' operationId: deletePageContent tags: - Pages parameters: - $ref: '#/components/parameters/docId' - $ref: '#/components/parameters/pageIdOrName' requestBody: description: Parameters for deleting page content. required: false content: application/json: schema: $ref: '#/components/schemas/PageContentDelete' responses: '202': description: A result indicating that the deletion was queued for processing. content: application/json: schema: $ref: '#/components/schemas/PageContentDeleteResult' '400': $ref: '#/components/responses/BadRequestError' '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 ''} # Delete all content from the page uri = f''https://coda.io/apis/v1/docs//pages//content'' req = requests.delete(uri, headers=headers) req.raise_for_status() res = req.json() print(f''Deleted all content from page {res["id"]}'') # => Deleted all content from page # Delete specific elements payload = {''elementIds'': [''cl-abc123'', ''cl-def456'']} req = requests.delete(uri, headers=headers, json=payload) req.raise_for_status() res = req.json() print(f''Deleted {len(payload["elementIds"])} elements from page {res["id"]}'') # => Deleted 2 elements from page ' - label: Shell lang: shell source: "# Delete specific elements\ncurl -s -H 'Authorization: Bearer ' -X DELETE \\\n -H \"Content-Type: application/json\" \\\n -d '{\"elementIds\": [\"cl-abc123\", \"cl-def456\"]}' \\\n 'https://coda.io/apis/v1/docs//pages//content' |\n jq '\"Deleted elements from page \" + .id'\n# => \"Deleted elements from page \"\n" - label: Google Apps Script lang: javascript source: '// Import the CodaAPI library via Resource->Libraries...: // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl CodaAPI.authenticate(''''); // Delete all content var res = CodaAPI.deletePageContent('''', ''''); Logger.log(''Deleted all content from page '' + res.id); // => Deleted all content from page ' /docs/{docId}/pages/{pageIdOrName}/export: post: summary: Begin content export description: Initiate an export of content for the given page. operationId: beginPageContentExport tags: - Pages parameters: - $ref: '#/components/parameters/docId' - $ref: '#/components/parameters/pageIdOrName' requestBody: description: Parameters for requesting a page content export. required: true content: application/json: schema: $ref: '#/components/schemas/BeginPageContentExportRequest' responses: '202': description: Export page content response. content: application/json: schema: $ref: '#/components/schemas/BeginPageContentExportResponse' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '410': $ref: '#/components/responses/GoneError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: "import requests\n\nheaders = {'Authorization': 'Bearer '}\nuri = f'https://coda.io/apis/v1/docs//pages//export'\npayload = {\n 'outputFormat': 'html',\n}\nreq = requests.post(uri, headers=headers, json=payload)\nreq.raise_for_status() # Throw if there was an error.\nres = req.json()\n\nprint(f'Export status available at {res[\"href\"]}')\n# => Export status available at \n" - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' -X POST -H \"Content-Type: application/json\" \\\n -d '{\"outputFormat\": \"html\"}' \\\n 'https://coda.io/apis/v1/docs//pages//export' |\n jq '\"Export status available at \" + .href'\n# => Export status available at \n" - label: Google Apps Script lang: javascript source: '// Import the CodaAPI library via Resource->Libraries...: // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl CodaAPI.authenticate(''''); var page = CodaAPI.beginPageContentExport('''', '''', {outputFormat: ''html''}); Logger.log(''Export status available at '' + page.href); // => Export status available at ' /docs/{docId}/pages/{pageIdOrName}/export/{requestId}: get: summary: Content export status description: Check the status of a page content export operationId: getPageContentExportStatus tags: - Pages parameters: - $ref: '#/components/parameters/docId' - $ref: '#/components/parameters/pageIdOrName' - $ref: '#/components/parameters/requestId' responses: '200': description: Info about the page content export request. content: application/json: schema: $ref: '#/components/schemas/PageContentExportStatusResponse' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '410': $ref: '#/components/responses/GoneError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = f''https://coda.io/apis/v1/docs//pages//export/'' res = requests.get(uri, headers=headers).json() print(f''Request status: {res["status"]}'') # => Request status: completed ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' \\\n -d '{\"outputFormat\": \"html\"}' \\\n 'https://coda.io/apis/v1/docs//pages//export/' |\n jq .status\n# => completed\n" - label: Google Apps Script lang: javascript source: '// Import the CodaAPI library via Resource->Libraries...: // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl CodaAPI.authenticate(''''); var response = CodaAPI.getPageContentExportStatus('''', '''', ''''); Logger.log(''Export status: '' + response.status); // => Export status: completed ' components: schemas: PageContent: x-schema-name: PageContent description: 'Content to be added or replaced with in a page (canvas). ' type: object additionalProperties: false required: - format - content properties: format: $ref: '#/components/schemas/PageContentFormat' content: type: string description: The actual page content. example:

This is rich text

PageContentFormat: x-schema-name: PageContentFormat description: Supported content types for page (canvas) content. type: string enum: - html - markdown x-tsEnumNames: - Html - Markdown PageContentDeleteResult: x-schema-name: PageContentDeleteResult description: The result of a page content deletion. allOf: - $ref: '#/components/schemas/DocumentMutateResponse' - type: object required: - id additionalProperties: false properties: id: type: string description: ID of the page whose content was deleted. example: canvas-tuVwxYz PageLineStyle: x-schema-name: PageLineStyle description: The style of a line element in a canvas page. type: string enum: - blockQuote - bulletedList - checkboxList - code - collapsibleList - h1 - h2 - h3 - numberedList - paragraph - pullQuote x-tsEnumNames: - BlockQuote - BulletedList - CheckboxList - Code - CollapsibleList - H1 - H2 - H3 - NumberedList - Paragraph - PullQuote PageContentOutputFormat: x-schema-name: PageContentOutputFormat description: Supported output content formats that can be requested for getting content for an existing page. type: string enum: - html - markdown x-tsEnumNames: - Html - Markdown PageContentInsertionMode: x-schema-name: PageContentInsertionMode description: Mode for updating the content on an existing page. type: string enum: - append - prepend - replace x-tsEnumNames: - Append - Prepend - Replace PageEmbedRenderMethod: x-schema-name: PageEmbedRenderMethod description: Render mode for a page using the Embed page type. type: string enum: - compatibility - standard x-tsEnumNames: - Compatibility - Standard PageContentUpdate: x-schema-name: PageContentUpdate description: Payload for updating the content of an existing page. type: object additionalProperties: false required: - insertionMode - canvasContent properties: insertionMode: $ref: '#/components/schemas/PageContentInsertionMode' elementId: type: string example: cl-lzqh0Q0poT description: 'ID of the element on the page to use as a reference point for editing content. If provided, the operation will be relative to this element (e.g., append after it, prepend before it, replace it). If omitted, the operation will be performed on the entire page (e.g., append to end, prepend to beginning, replace all). ' canvasContent: $ref: '#/components/schemas/PageContent' PageType: x-schema-name: PageType description: The type of a page in a doc. type: string enum: - canvas - embed - syncPage x-tsEnumNames: - Canvas - Embed - SyncPage nextPageToken: description: If specified, an opaque token used to fetch the next page of results. type: string example: eyJsaW1pd LinkedDataType: x-schema-name: LinkedDataType description: A schema.org identifier for the object. type: string enum: - ImageObject - MonetaryAmount - Person - WebPage - StructuredValue x-tsEnumNames: - ImageObject - MonetaryAmount - Person - WebPage - StructuredValue PageUpdateResult: x-schema-name: PageUpdateResult description: The result of a page update. allOf: - $ref: '#/components/schemas/DocumentMutateResponse' - type: object required: - id additionalProperties: false properties: id: type: string description: ID of the updated page. example: canvas-tuVwxYz BeginPageContentExportResponse: x-schema-name: BeginPageContentExportResponse description: Response when beginning an export of page content. type: object additionalProperties: false required: - id - status - href properties: id: type: string description: The identifier of this export request. example: AbCDeFGH status: type: string description: The status of this export. example: complete href: type: string description: The URL that reports the status of this export. Poll this URL to get the content URL when the export has completed. example: https://coda.io/apis/v1/docs/somedoc/pages/somepage/export/some-request-id Icon: x-schema-name: icon description: Info about the icon. type: object required: - name - type - browserLink additionalProperties: false properties: name: type: string description: Name of the icon. type: type: string description: MIME type of the icon browserLink: type: string format: url description: Browser-friendly link to an icon. example: https://cdn.coda.io/icons/png/color/icon-32.png PageContentItemType: x-schema-name: PageContentItemType description: The type of content item in a page. type: string enum: - line x-tsEnumNames: - Line PageCreate: x-schema-name: PageCreate description: Payload for creating a new page in a doc. type: object additionalProperties: false properties: name: type: string description: Name of the page. example: Launch Status subtitle: type: string description: Subtitle of the page. example: See the status of launch-related tasks. iconName: type: string description: Name of the icon. example: rocket imageUrl: type: string description: Url of the cover image to use. example: https://example.com/image.jpg parentPageId: type: string description: The ID of this new page's parent, if creating a subpage. example: canvas-tuVwxYz pageContent: $ref: '#/components/schemas/PageCreateContent' PageContentItemContent: x-schema-name: PageContentItemContent description: Content details of the item. type: object required: - style - format - content additionalProperties: false properties: style: $ref: '#/components/schemas/PageLineStyle' format: $ref: '#/components/schemas/PageContentItemContentFormat' content: type: string description: Content of the item in the specified format. example: This is a paragraph of text. lineLevel: type: integer description: 'Indentation level of the element. Present for indentable elements (paragraphs, blockquotes, and list items). ' example: 0 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 BeginPageContentExportRequest: x-schema-name: BeginPageContentExportRequest description: Request for beginning an export of page content. type: object additionalProperties: false required: - outputFormat properties: outputFormat: $ref: '#/components/schemas/PageContentOutputFormat' DocumentMutateResponse: x-schema-name: DocumentMutateResponse description: Base response type for an operation that mutates a document. type: object additionalProperties: false required: - requestId properties: requestId: type: string description: An arbitrary unique identifier for this request. example: abc-123-def-456 Page: x-schema-name: Page description: Metadata about a page. type: object required: - id - type - href - name - isHidden - isEffectivelyHidden - browserLink - children - contentType 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 subtitle: type: string description: Subtitle of the page. example: See the status of launch-related tasks. icon: $ref: '#/components/schemas/Icon' image: $ref: '#/components/schemas/Image' contentType: $ref: '#/components/schemas/PageType' isHidden: type: boolean description: Whether the page is hidden in the UI. example: true isEffectivelyHidden: type: boolean description: Whether the page or any of its parents is hidden in the UI. example: true parent: $ref: '#/components/schemas/PageReference' children: type: array items: $ref: '#/components/schemas/PageReference' authors: description: Authors of the page type: array items: $ref: '#/components/schemas/PersonValue' createdAt: type: string format: date-time description: Timestamp for when the page was created. example: '2018-04-11T00:18:57.946Z' createdBy: $ref: '#/components/schemas/PersonValue' updatedAt: type: string format: date-time description: Timestamp for when page content was last modified. example: '2018-04-11T00:18:57.946Z' updatedBy: $ref: '#/components/schemas/PersonValue' PageContentExportStatusResponse: x-schema-name: PageContentExportStatusResponse description: Response when requesting the status of a page content export. type: object additionalProperties: false required: - id - status - href properties: id: type: string description: The identifier of this export request. example: AbCDeFGH status: type: string description: The status of this export. example: complete href: type: string description: The URL that reports the status of this export. example: https://coda.io/apis/v1/docs/somedoc/pages/somepage/export/some-request-id downloadLink: type: string description: Once the export completes, the location where the resulting export file can be downloaded; this link typically expires after a short time. Call this method again to get a fresh link. example: https://coda.io/blobs/DOC_EXPORT_RENDERING/some-request-id error: type: string description: Message describing an error, if this export failed. PageContentList: x-schema-name: PageContentList description: List of page content elements. type: object required: - items - href additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/PageContentItem' href: type: string format: url description: API link to these results example: https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO/content?limit=20 nextPageToken: $ref: '#/components/schemas/nextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/nextPageLink' - type: string example: https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO/content?pageToken=eyJsaW1pd LinkedDataObject: x-schema-name: LinkedDataObject description: Base type for a JSON-LD (Linked Data) object. type: object additionalProperties: false required: - '@context' - '@type' properties: '@context': type: string description: A url describing the schema context for this object, typically "http://schema.org/". example: http://schema.org/ '@type': $ref: '#/components/schemas/LinkedDataType' additionalType: type: string description: 'An identifier of additional type info specific to Coda that may not be present in a schema.org taxonomy, ' nextPageLink: description: If specified, a link that can be used to fetch the next page of results. type: string format: url PageDeleteResult: x-schema-name: PageDeleteResult description: The result of a page deletion. allOf: - $ref: '#/components/schemas/DocumentMutateResponse' - type: object required: - id additionalProperties: false properties: id: type: string description: ID of the page to be deleted. example: canvas-tuVwxYz Image: x-schema-name: Image description: Info about the image. type: object required: - browserLink additionalProperties: false properties: browserLink: type: string format: url description: Browser-friendly link to an image. example: https://codahosted.io/docs/nUYhlXysYO/blobs/bl-lYkYKNzkuT/3f879b9ecfa27448 type: type: string description: MIME type of the image. width: type: number description: The width in pixels of the image. example: 800 height: type: number description: The height in pixels of the image. example: 600 PageContentDelete: x-schema-name: PageContentDelete description: Payload for deleting content from a page. type: object additionalProperties: false properties: elementIds: type: array description: 'IDs of the elements to delete from the page. If omitted or empty, all content will be deleted. ' items: type: string example: - cl-lzqh0Q0poT - cl-abc123def PageList: x-schema-name: PageList description: List of pages. type: object required: - items additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/Page' href: type: string format: url description: API link to these results example: https://coda.io/apis/v1/docs/AbCDeFGH/pages?limit=20 nextPageToken: $ref: '#/components/schemas/nextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/nextPageLink' - type: string example: https://coda.io/apis/v1/docs/AbCDeFGH/pages?pageToken=eyJsaW1pd PageCreateContent: x-schema-name: PageCreateContent description: Content that can be added to a page at creation time, either text (or rich text) or a URL to create a full-page embed. discriminator: propertyName: type oneOf: - type: object required: - type - canvasContent additionalProperties: false properties: type: type: string description: Indicates a page containing canvas content. enum: - canvas x-tsType: PageType.Canvas canvasContent: $ref: '#/components/schemas/PageContent' - type: object required: - type - url additionalProperties: false properties: type: type: string description: Indicates a page that embeds other content. enum: - embed x-tsType: PageType.Embed url: type: string description: The URL of the content to embed. example: https://example.com renderMethod: $ref: '#/components/schemas/PageEmbedRenderMethod' - discriminator: propertyName: mode oneOf: - type: object required: - type - mode - sourcePageId - includeSubpages - sourceDocId additionalProperties: false properties: type: type: string description: Indicates a page that embeds other Coda content. enum: - syncPage x-tsType: PageType.SyncPage mode: type: string description: Indicates a single-page sync page. enum: - page x-tsType: SyncPageType.Page includeSubpages: type: boolean description: Include subpages in the sync page. sourcePageId: type: string description: The page id to insert as a sync page. example: canvas-IjkLmnO sourceDocId: type: string description: The id of the document to insert as a sync page. example: sHbI4uIwiK - type: object required: - type - mode - sourceDocId additionalProperties: false properties: type: type: string description: Indicates a page that embeds other content. enum: - syncPage x-tsType: PageType.SyncPage mode: type: string description: Indicates a full doc sync page. enum: - document x-tsType: SyncPageType.Document sourceDocId: type: string description: The id of the document to insert as a sync page. example: sHbI4uIwiK PageUpdate: x-schema-name: PageUpdate description: Payload for updating a page. type: object additionalProperties: false properties: name: type: string description: Name of the page. example: Launch Status subtitle: type: string description: Subtitle of the page. example: See the status of launch-related tasks. iconName: type: string description: Name of the icon. example: rocket imageUrl: type: string description: Url of the cover image to use. example: https://example.com/image.jpg isHidden: type: boolean description: Whether the page is hidden or not. Note that for pages that cannot be hidden, like the sole top-level page in a doc, this will be ignored. example: true contentUpdate: allOf: - type: object description: Content with which to update an existing page. additionalProperties: false - $ref: '#/components/schemas/PageContentUpdate' PageContentItemContentFormat: x-schema-name: PageContentItemContentFormat description: Content format for the item. type: string enum: - plainText x-tsEnumNames: - PlainText PersonValue: x-schema-name: PersonValue description: A named reference to a person, where the person is identified by email address. allOf: - $ref: '#/components/schemas/LinkedDataObject' - type: object additionalProperties: false required: - '@type' - name properties: '@type': type: string enum: - Person x-tsType: LinkedDataType.Person name: type: string description: The full name of the person. example: Alice Atkins email: type: string description: The email address of the person. example: alice@atkins.com PageContentItem: x-schema-name: PageContentItem description: Content item in a page (canvas). type: object required: - id - type additionalProperties: false properties: id: type: string description: ID of the content item. example: cl-2ZUJuRhNuN type: $ref: '#/components/schemas/PageContentItemType' itemContent: $ref: '#/components/schemas/PageContentItemContent' PageCreateResult: x-schema-name: PageCreateResult description: The result of a page creation. allOf: - $ref: '#/components/schemas/DocumentMutateResponse' - type: object required: - id additionalProperties: false properties: id: type: string description: ID of the created page. example: canvas-tuVwxYz parameters: pageIdOrName: name: pageIdOrName description: 'ID or name of the page. Names are discouraged because they''re easily prone to being changed by users. If you''re using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected. ' x-sdk-description: 'ID or name of the page. Names are discouraged because they''re easily prone to being changed by users. Note that if you''re using a name and there are multiple pages with the same name, an arbitrary one will be returned. ' in: path required: true example: canvas-IjkLmnO schema: type: string docId: name: docId description: ID of the doc. in: path required: true example: AbCDeFGH schema: type: string requestId: name: requestId description: ID of the request. in: path required: true example: abc-123-def-456 schema: type: string limit: name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 pageContentLimit: name: limit description: Maximum number of content items to return in this query. in: query example: 50 schema: type: integer minimum: 1 maximum: 500 default: 50 contentFormat: name: contentFormat description: The format to return content in. Defaults to plainText. in: query example: plainText schema: type: string enum: - plainText default: plainText pageToken: name: pageToken description: An opaque token used to fetch the next page of results. in: query example: eyJsaW1pd schema: type: string responses: BadRequestError: description: The request parameters did not conform to expectations. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 400 statusMessage: type: string description: HTTP status message of the error. example: Bad Request message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Bad Request GoneError: description: The resource has been deleted. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 410 statusMessage: type: string description: HTTP status message of the error. example: Gone message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Gone NotFoundError: description: The resource could not be located with the current API token. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 404 statusMessage: type: string description: HTTP status message of the error. example: Not Found message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Not Found ForbiddenError: description: The API token does not grant access to this resource. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 403 statusMessage: type: string description: HTTP status message of the error. example: Forbidden message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Forbidden TooManyRequestsError: description: The client has sent too many requests. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 429 statusMessage: type: string description: HTTP status message of the error. example: Too Many Requests message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Too Many Requests UnauthorizedError: description: The API token is invalid or has expired. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 401 statusMessage: type: string description: HTTP status message of the error. example: Unauthorized message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Unauthorized securitySchemes: Bearer: description: "The Coda API can be accessed using an API token, which can be obtained from [*My account*](https://coda.io/account)\nin Coda. This token should be specified by setting a header as follows.\n\n```Authorization: Bearer ```\n\nKeep your token safe, as anyone who gets access to it can access your account. Once a token is created\nit cannot be viewed or modified, so don't lose it.\n\nIf you're logged into Coda, you can also query the API directly using your browser. Note that only GET\nendpoints are supported; for anything else, you'll have to use Bearer authentication.\n\n### Restricting token authorization\n\nBy default, bearer tokens created for the Coda API can perform any action that the user who created the token\ncan perform. However, Coda API bearer tokens can also be created with restrictions. These restrictions\ncan limit what objects can be operated on and the types of operations that can be performed.\n\n#### Operation types\n\nThe table below describes the types of authorization restrictions that can be placed on a Coda API token.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
RestrictionDescriptionAllowed HTTP Methods
Read accessAllows access to API methods that read the state of an objectGET
Write accessAllows access to API methods that write the state of an objectPOST, PUT, DELETE
Read and write accessAllows access to all methods for an objectAll
\n\n#### Object types\n\nCoda API tokens can be restricted to the following types of objects.\n\n* Documents: Restricts access to only allow API calls for `/docs/${DOC_ID}`\n* Tables: Restricts access to only allow API calls for `/docs/${DOC_ID}/tables/${TABLE_ID}`\n\n#### Special cases\n\nThere are a few special case methods that violate the above restrictions.\n\n* `/whoami`: This method can be called by all Coda API tokens.\n* `/resolveBrowserLink`: This method can be called by all Coda API tokens, but will only return a result\nif the token has access (read or write) to the object referenced by the URL.\n\n#### Feedback\n\nThis feature is under development and we'd love to hear your feedback and bug reports. Please\nvisit us at the [Developers Central](https://connect.superhuman.com/c/developers-central) forum within\nthe Coda Community.\n" type: http scheme: bearer bearerFormat: UUID x-tagGroups: - name: Folders tags: - Folders - name: Docs tags: - Docs - Permissions - Publishing - name: Doc Structure tags: - Pages - Automations - name: Tables and Views tags: - Tables - Columns - Rows - name: Formulas & Controls tags: - Formulas - Controls - name: Miscellaneous tags: - Account - Analytics - Miscellaneous