{"openapi":"3.0.0","info":{"version":"1.5.0","title":"Coda 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## 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\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 MunĚ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)"}],"tags":[{"name":"Account","description":"At this time, the API exposes some limited information about your account. However, `/whoami` is a good endpoint to hit to verify that you're hitting the API correctly and that your token is working as expected.\n"},{"name":"Analytics","description":"This API offers analytics data for your docs and Packs over time."},{"name":"Automations","description":"This API allows you to trigger automations."},{"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.\n"},{"name":"Controls","description":"Controls provide a user-friendly way to input a value that can affect other parts of the doc. This API lets you list controls and get their current values.\n"},{"name":"Docs","description":"Coda docs are foundational, top-level collaborative projects that contain pages. The API lets you list and search your docs to obtain basic metadata like titles and ownership information.\n"},{"name":"Folders","description":"Folders help you organize your docs within workspaces. This API lets you list, create, update, and delete folders.\n"},{"name":"Formulas","description":"Formulas can be great for performing one-off computations, or used with tables and other formulas to compute a single value. With this API, you can discover formulas in a doc and obtain computed results.\n"},{"name":"Miscellaneous","description":"These endpoints wouldn't fit anywhere else, but you may find them useful when working with Coda.\n"},{"name":"Packs","description":"This API allows you to manage Packs that you have developed as well as list publicly available Coda packs.\n"},{"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.\n"},{"name":"Permissions","description":"This API lets you manage sharing and permissions for your docs."},{"name":"Publishing","description":"Coda docs can be published publicly and associated with categories to help the world discover them. This API lets you manage the publishing settings of your docs.\n"},{"name":"Rows","description":"You'll likely use this part of the API the most. These endpoints let you retrieve row data from tables in Coda as well as create, upsert, update, and delete them. Most of these endpoints work for both base tables and views, but for inserting/upsering rows, you must use a base table.\n"},{"name":"Tables and Views","description":"If you're here, you know the power of tables in Coda. This API lets you list the tables and views in a Coda doc and obtain basic schema information.\n"},{"name":"Workspaces","description":"This API allows you to manage your workspace's membership and get analytics on membership over time.\n"}],"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"]}],"paths":{"/categories":{"get":{"summary":"Get doc categories","description":"Gets all available doc categories.","operationId":"listCategories","tags":["Publishing"],"responses":{"200":{"description":"List of doc categories","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocCategoryList"}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"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/categories'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'Category count: {res[\"categories\"].length}')\n# => Category count: 10\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/categories' |\n jq .categories.name\n# => \"10\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar categories = CodaAPI.listCategories();\nLogger.log('Category count: ' + categories.categories.length);\n// => Category count: 10\n"}]}},"/docs":{"get":{"summary":"List available docs","description":"Returns a list of Coda docs accessible by the user, and which they have opened at least once. These are returned in the same order as on the docs page: reverse chronological by the latest event relevant to the user (last viewed, edited, or shared).\n","operationId":"listDocs","tags":["Docs"],"parameters":[{"name":"isOwner","in":"query","description":"Show only docs owned by the user.","schema":{"type":"boolean"}},{"name":"isPublished","in":"query","description":"Show only published docs.","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/query"},{"name":"sourceDoc","in":"query","description":"Show only docs copied from the specified doc ID.","schema":{"type":"string"}},{"name":"isStarred","in":"query","description":"If true, returns docs that are starred. If false, returns docs that are not starred.","schema":{"type":"boolean"}},{"name":"inGallery","in":"query","description":"Show only docs visible within the gallery.","schema":{"type":"boolean"}},{"name":"workspaceId","in":"query","description":"Show only docs belonging to the given workspace.","schema":{"type":"string"}},{"name":"folderId","in":"query","description":"Show only docs belonging to the given folder.","schema":{"type":"string"}},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/pageToken"}],"responses":{"200":{"description":"List of Coda docs matching the query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocList"}}}},"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 = 'https://coda.io/apis/v1/docs'\nparams = {\n 'isOwner': True,\n 'query': 'New',\n}\nres = requests.get(uri, headers=headers, params=params).json()\n\nprint(f'First doc is: {res[\"items\"][0][\"name\"]}')\n# => First doc is: New Document\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs' |\n jq .items[0].name\n# => \"New Document\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar docs = CodaAPI.listDocs().items;\nLogger.log('First doc is ' + docs[0].name);\n// => First doc is: New Document\n"}]},"post":{"summary":"Create doc","description":"Creates a new Coda doc, optionally copying an existing doc. Note that creating a doc requires you to be a Doc Maker in the applicable workspace (or be auto-promoted to one).\n","operationId":"createDoc","tags":["Docs"],"requestBody":{"description":"Parameters for creating the doc.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocCreate"}}}},"responses":{"201":{"description":"Info about the created doc.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreationResult"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"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'\npayload = {\n 'title': 'Project Tracker',\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'New doc created with name \"{res[\"name\"]}\"')\n# => New doc created with name \"Project Tracker\"\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' -X POST -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"Project Tracker\"}' \\\n 'https://coda.io/apis/v1/docs' |\n jq .name\n# => \"Project Tracker\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar res = CodaAPI.createDoc({title: 'Project Tracker'});\nLogger.log('New doc created with name ' + res.name);\n// => First doc in the results is: New Document\n"}]}},"/docs/{docId}":{"get":{"summary":"Get info about a doc","description":"Returns metadata for the specified doc.","operationId":"getDoc","tags":["Docs"],"parameters":[{"$ref":"#/components/parameters/docId"}],"responses":{"200":{"description":"Basic Coda doc metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Doc"}}}},"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/'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'The name of the doc is {res[\"name\"]}')\n# => The name of the doc is New Document\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs/' |\n jq .name\n# => \"New Document\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar docInfo = CodaAPI.getDoc('');\nLogger.log('The name of the doc is ' + docInfo.name);\n// => The name of the doc is New Document\n"}]},"delete":{"summary":"Delete doc","description":"Deletes a doc.","operationId":"deleteDoc","tags":["Docs"],"parameters":[{"$ref":"#/components/parameters/docId"}],"responses":{"202":{"description":"A result indicating that the doc was deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocDelete"}}}},"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/'\nres = requests.delete(uri, headers=headers).json()\n"},{"label":"Shell","lang":"shell","source":"curl -s -X DELETE -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs/' |\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar docInfo = CodaAPI.deleteDoc('');\n// => The given doc is now deleted\n"}]},"patch":{"summary":"Update doc","description":"Updates metadata for a doc. Note that updating a doc title requires you to be a Doc Maker in the applicable workspace.","operationId":"updateDoc","tags":["Docs"],"parameters":[{"$ref":"#/components/parameters/docId"}],"requestBody":{"description":"Parameters for updating the doc.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocUpdate"}}}},"responses":{"200":{"description":"Basic Coda doc metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocUpdateResult"}}}},"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/'\npayload = {\n 'title': 'New Doc Title',\n}\nreq = requests.patch(uri, headers=headers, json=payload)\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' -X PATCH -H \"Content-Type: application/json\" \\\n -d '{\"title\": \"New Doc Title\"}' \\\n 'https://coda.io/apis/v1/docs/'\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nCodaAPI.updateDoc(, {title: \"New Doc Title\"});\n"}]}},"/docs/{docId}/acl/metadata":{"get":{"summary":"Get sharing metadata","description":"Returns metadata associated with sharing for this Coda doc.","operationId":"getSharingMetadata","tags":["Permissions"],"parameters":[{"$ref":"#/components/parameters/docId"}],"responses":{"200":{"description":"Metadata associated with sharing permissions for a doc.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclMetadata"}}}},"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//acl/metadata'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'Can I share this doc with others? {res[\"canShare\"]}')\n# => Can I share this doc with others? true\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//acl/metadata' |\n jq .canShare\n# => \"true\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar docSharingMetadata = CodaAPI.getSharingMetadata('');\nLogger.log('Can I share this doc with others? ' + docSharingMetadata.canShare);\n// => Can I share this doc with others? true\n"}]}},"/docs/{docId}/acl/permissions":{"get":{"summary":"List permissions","description":"Returns a list of permissions for this Coda doc.","operationId":"getPermissions","tags":["Permissions"],"parameters":[{"$ref":"#/components/parameters/docId"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/pageToken"}],"responses":{"200":{"description":"List of permissions for a doc.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Acl"}}}},"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//acl/permissions'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'First user with access is {res[\"items\"][0][\"principal\"][\"email\"]}')\n# => First user with access is foo@bar.com\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//acl/permissions' |\n jq '.items[].principal.email'\n# => \"foo@bar.com\", \"baz@bar.com\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar docPermissions = CodaAPI.getPermissions('');\nLogger.log('First user with access is ' + docPermissions[0].principal.email);\n// => First user with access is foo@bar.com\n"}]},"post":{"summary":"Add permission","description":"Adds a new permission to the doc.\n","operationId":"addPermission","tags":["Permissions"],"parameters":[{"$ref":"#/components/parameters/docId"}],"requestBody":{"description":"Parameters for adding the new permission.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPermissionRequest"}}}},"responses":{"200":{"description":"Confirmation that the request was applied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPermissionResult"}}}},"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//acl/permissions'\npayload = {\n 'access': 'write',\n 'principal': {\n 'type': 'email',\n 'email': 'foo@bar.com'\n },\n}\nres = requests.post(uri, headers=headers, json=payload)\n\n# => Grant 'foo@bar.com' write access to the doc and send a share notification email\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' -X POST \\\n 'https://coda.io/apis/v1/docs//acl/permissions' \\\n -d '{\"access\": \"write\", \"principal\": {\"type\": \"email\", \"email\": \"foo@bar.com\"}}'\n# => Grant 'foo@bar.com' write access to the doc and send a share notification email\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar docPermissions = CodaAPI.addPermission(\n '',\n {access: 'write', principal: {type: 'email', email: 'foo@bar.com'}}\n);\n// => Grant 'foo@bar.com' write access to the doc and send a share notification email\n"}]}},"/docs/{docId}/acl/permissions/{permissionId}":{"delete":{"summary":"Delete permission","description":"Deletes an existing permission.\n","operationId":"deletePermission","tags":["Permissions"],"parameters":[{"$ref":"#/components/parameters/docId"},{"$ref":"#/components/parameters/permissionId"}],"responses":{"200":{"description":"Confirmation that the request was applied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePermissionResult"}}}},"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//acl/permissions/'\nres = requests.delete(uri, headers=headers, json=payload)\n\n# => Revoke access to the doc\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' -X DELETE \\\n 'https://coda.io/apis/v1/docs//acl/permissions/'\n# => Revoke access to the doc\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar docPermissions = CodaAPI.deletePermission('', '');\n// => Revoke access to the doc\n"}]}},"/docs/{docId}/acl/principals/search":{"get":{"summary":"Search principals","description":"Searches for user and group principals matching the query that this doc can be shared with.\nAt most 20 results will be returned for both users and groups. If no query is given then no results are returned.\n","operationId":"searchPrincipals","tags":["Permissions"],"parameters":[{"$ref":"#/components/parameters/docId"},{"$ref":"#/components/parameters/query"}],"responses":{"200":{"description":"Search results for the given query.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPrincipalsResponse"}}}},"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//acl/principals/search?search=foo'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'First user with access is {res[\"users\"][0][\"email\"]}')\n# => First user with access is foo@bar.com\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//acl/permissions/search?search=foo' |\n jq '.users[].email'\n# => \"foo@bar.com\", \"baz@bar.com\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar principals = CodaAPI.searchPrincipals('');\nLogger.log('First user with access is ' + docPermissions[0].principal.email);\n// => First user with access is foo@bar.com\n"}]}},"/docs/{docId}/acl/settings":{"get":{"summary":"Get ACL settings","description":"Returns settings associated with ACLs for this Coda doc.","operationId":"getAclSettings","tags":["Permissions"],"parameters":[{"$ref":"#/components/parameters/docId"}],"responses":{"200":{"description":"Settings associated with access control for a doc.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclSettings"}}}},"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//acl/settings'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'Can editors change sharing permissions? {res[\"allowEditorsToChangePermissions\"]}')\n# => Can editors change sharing permissions? false\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//acl/settings' |\n jq .allowEditorsToChangePermissions\n# => \"false\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar settings = CodaAPI.getAclSettings('');\nLogger.log('Can editors change sharing permissions? ' + settings.allowEditorsToChangePermissions);\n// => Can editors change sharing permissions? true\n"}]},"patch":{"summary":"Update ACL settings","description":"Update settings associated with ACLs for this Coda doc.","operationId":"updateAclSettings","tags":["Permissions"],"parameters":[{"$ref":"#/components/parameters/docId"}],"requestBody":{"description":"Parameters for updating the ACL settings.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAclSettingsRequest"}}}},"responses":{"200":{"description":"Settings associated with access control for a doc.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AclSettings"}}}},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"429":{"$ref":"#/components/responses/TooManyRequestsError"}}}},"/docs/{docId}/publish":{"put":{"summary":"Publish doc","description":"Update publish settings for a doc.","operationId":"publishDoc","tags":["Publishing"],"parameters":[{"$ref":"#/components/parameters/docId"}],"requestBody":{"description":"Parameters for changing publish settings.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocPublish"}}}},"responses":{"202":{"description":"Confirmation that the publish request was accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishResult"}}}},"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//publish'\npayload = {\n 'discoverable': true,\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'Discoverable will be true')\n# => Discoverable will be true\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' -X POST -H \"Content-Type: application/json\" \\\n -d '{\"discoverable\": true}' \\\n 'https://coda.io/apis/v1/docs//publish'\n # => Will be discoverable\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar res = CodaAPI.publishDoc(, {discoverable: true});\nLogger.log('Discoverable will be true');\n// => Discoverable will be true\n"}]},"delete":{"summary":"Unpublish doc","description":"Unpublishes a doc.","operationId":"unpublishDoc","tags":["Publishing"],"parameters":[{"$ref":"#/components/parameters/docId"}],"responses":{"200":{"description":"A result indicating that the doc was unpublished.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpublishResult"}}}},"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//publish'\nres = requests.unpublishDoc(uri, headers=headers).json()\n"},{"label":"Shell","lang":"shell","source":"curl -s -X DELETE -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//unpublish' |\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar docInfo = CodaAPI.unpublishDoc('');\n// => The given doc is now unpublished\n"}]}},"/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\n\nheaders = {'Authorization': 'Bearer '}\nuri = f'https://coda.io/apis/v1/docs//pages'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'The name of the first page is {res[\"items\"][0][\"name\"]}')\n# => The name of the first page is Page 1\n"},{"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...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar pages = CodaAPI.listPages('').items;\nLogger.log('The name of the first page is ' + pages[0].name);\n// => The name of the first page is Page 1\n"}]},"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.\n","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...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar res = CodaAPI.createPage(, {name: \"New Page Name\"});\nLogger.log('Created page ' + res.id);\n// => Created page \n"}]}},"/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\n\nheaders = {'Authorization': 'Bearer '}\nuri = f'https://coda.io/apis/v1/docs//pages/'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'The name of this page is {res[\"name\"]}')\n# => The name of this page is Page 1\n"},{"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...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar page = CodaAPI.getPage('', '');\nLogger.log('The name of this page is ' + page.name);\n// => The name of this page is Page 1\n"}]},"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.\n","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...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar res = CodaAPI.updatePage(, , {name: \"New Page Name\"});\nLogger.log('Updated page ' + res.id);\n// => Updated page \n"}]},"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\n\nheaders = {'Authorization': 'Bearer '}\nuri = f'https://coda.io/apis/v1/docs//pages/'\nreq = requests.delete(uri, headers=headers)\nreq.raise_for_status() # Throw if there was an error.\nres = req.json()\n\nprint(f'Deleted page')\n# => Deleted page\n"},{"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...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nCodaAPI.deleteRows('', '');\nLogger.log('Deleted 2 rows');\n// => Deleted page\n"}]}},"/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\n\nheaders = {'Authorization': 'Bearer '}\nuri = f'https://coda.io/apis/v1/docs//pages//content'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'The page has {len(res[\"items\"])} content elements')\n# => The page has 10 content elements\n"},{"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...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar content = CodaAPI.listPageContent('', '');\nLogger.log('The page has ' + content.items.length + ' content elements');\n// => The page has 10 content elements\n"}]},"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.\n","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\n\nheaders = {'Authorization': 'Bearer '}\n\n# Delete all content from the page\nuri = f'https://coda.io/apis/v1/docs//pages//content'\nreq = requests.delete(uri, headers=headers)\nreq.raise_for_status()\nres = req.json()\nprint(f'Deleted all content from page {res[\"id\"]}')\n# => Deleted all content from page \n\n# Delete specific elements\npayload = {'elementIds': ['cl-abc123', 'cl-def456']}\nreq = requests.delete(uri, headers=headers, json=payload)\nreq.raise_for_status()\nres = req.json()\nprint(f'Deleted {len(payload[\"elementIds\"])} elements from page {res[\"id\"]}')\n# => Deleted 2 elements from page \n"},{"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...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\n\n// Delete all content\nvar res = CodaAPI.deletePageContent('', '');\nLogger.log('Deleted all content from page ' + res.id);\n// => Deleted all content from page \n"}]}},"/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...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar page = CodaAPI.beginPageContentExport('', '', {outputFormat: 'html'});\nLogger.log('Export status available at ' + page.href);\n// => Export status available at \n"}]}},"/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\n\nheaders = {'Authorization': 'Bearer '}\nuri = f'https://coda.io/apis/v1/docs//pages//export/'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'Request status: {res[\"status\"]}')\n# => Request status: completed\n"},{"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...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar response = CodaAPI.getPageContentExportStatus('', '', '');\nLogger.log('Export status: ' + response.status);\n// => Export status: completed\n"}]}},"/docs/{docId}/tables":{"get":{"summary":"List tables","description":"Returns a list of tables in a Coda doc.","operationId":"listTables","tags":["Tables"],"parameters":[{"$ref":"#/components/parameters/docId"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/pageToken"},{"$ref":"#/components/parameters/sortBy"},{"$ref":"#/components/parameters/tableTypes"}],"responses":{"200":{"description":"List of tables or views in a doc.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableList"}}}},"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//tables'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'The name of the first table is {res[\"items\"][0][\"name\"]}')\n# => The name of the first table is To-do List\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//tables' |\n jq '.items[0].name'\n# => \"To-do List\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar tables = CodaAPI.listTables('').items;\nLogger.log('The name of the first table is ' + tables[0].name);\n// => The name of the first table is To-do List\n"}]}},"/docs/{docId}/tables/{tableIdOrName}":{"get":{"summary":"Get a table","description":"Returns details about a specific table or view.","operationId":"getTable","tags":["Tables"],"parameters":[{"$ref":"#/components/parameters/docId"},{"$ref":"#/components/parameters/tableIdOrName"},{"name":"useUpdatedTableLayouts","in":"query","description":"Return \"detail\" and \"form\" for the `layout` field of detail and form layouts respectively (instead of \"masterDetail\" for both)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Info about a table.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Table"}}}},"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//tables/'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'Table {res[\"name\"]} has {res[\"rowCount\"]} rows')\n# => Table To-do List has 2 rows\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//tables/' |\n jq '\"Table \" + .name + \" has \" + (.rowCount | tostring) + \" rows\"'\n# => \"Table To-do List has 2 rows\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar table = CodaAPI.getTable('', '');\nLogger.log('Table ' + table.name + ' has ' + table.rowCount + ' rows');\n// => Table To-do List has 2 rows\n"}]}},"/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\n\nheaders = {'Authorization': 'Bearer '}\nuri = f'https://coda.io/apis/v1/docs//tables//columns'\nres = requests.get(uri, headers=headers).json()\n\nprint(f'This table\\'s columns: {\", \".join(c[\"name\"] for c in res[\"items\"])}')\n# => This table's columns: Task, Duration (hr), Duration (min)\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//tables//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...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar columns = CodaAPI.listColumns('', '').items;\nvar names = columns.map(function(column) { return column.name; });\nLogger.log('This table\\'s columns: ' + names.join(', '));\n// => This table's columns: Task, Duration (hr), Duration (min)\n"}]}},"/docs/{docId}/tables/{tableIdOrName}/rows":{"get":{"summary":"List table rows","description":"Returns a list of rows in a table.\n### Value results\nThe `valueFormat` parameter dictates in what format the API should return values for individual cells.\n* `simple` (default): Returns cell values as the following JSON values: `string`, `number`, or `boolean`. Array values (like multiselects) are returned as comma-delimited strings.\n* `simpleWithArrays`: Singleton values are returned as `simple`. Array values are returned as JSON arrays and the values within are `simple` values (including nested arrays).\n* `rich`: If applicable, returns many values with further encoding, allowing API users to have lossless access to data in Coda.\n * For `text` values, returns data in Markdown syntax. If the text field is simple text (e.g. has no formatting),\n the field will be fully escaped with triple-ticks. E.g\n `\n ```This is plain text```\n `\n * For `currency`, `lookup`, `image`, `person` and `hyperlink` values, the value will be encoded in [JSON-LD](https://json-ld.org/) format.\n\n```\n // Currency\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"MonetaryAmount\",\n \"currency\": \"USD\",\n \"amount\": 42.42\n }\n\n // Lookup\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"StructuredValue\",\n \"additionalType\": \"row\",\n \"name\": \"Row Name\",\n \"rowId\": \"i-123456789\",\n \"tableId\": \"grid-123456789\",\n \"tableUrl\": \"https://coda.io/d/_d123456789/grid-123456789\",\n \"url\": \"https://coda.io/d/_d123456789/grid-123456789#_r42\",\n }\n\n // Hyperlink\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"WebPage\",\n \"name\": \"Coda\",\n \"url\": \"https://coda.io\"\n }\n\n // Image\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"ImageObject\",\n \"name\": \"Coda logo\",\n \"url\": \"https://coda.io/logo.jpg\"\n }\n\n // People\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"Person\",\n \"name\": \"Art Vandalay\",\n \"email\": \"art@vandalayindustries.com\"\n }\n```\n","operationId":"listRows","tags":["Rows"],"parameters":[{"$ref":"#/components/parameters/docId"},{"$ref":"#/components/parameters/tableIdOrName"},{"name":"query","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\"`).\n","in":"query","example":"c-tuVwxYz:\"Apple\"","schema":{"type":"string"}},{"name":"sortBy","in":"query","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.\n","schema":{"$ref":"#/components/schemas/RowsSortBy"}},{"$ref":"#/components/parameters/useColumnNames"},{"name":"valueFormat","in":"query","description":"The format that cell values are returned as.","schema":{"$ref":"#/components/schemas/ValueFormat"}},{"name":"visibleOnly","description":"If true, returns only visible rows and columns for the table.","in":"query","example":true,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/pageToken"},{"$ref":"#/components/parameters/syncToken"}],"responses":{"200":{"description":"List of rows in the table.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowList"}}}},"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//tables//rows'\nparams = {\n 'query': ':\"Work out\"',\n}\nreq = requests.get(uri, headers=headers, params=params)\nreq.raise_for_status() # Throw if there was an error.\nres = req.json()\n\nprint(f'Matching rows: {len(res[\"items\"])}')\n# => Matching rows: 1\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n -G --data-urlencode 'query=:\"Work out\"' \\\n 'https://coda.io/apis/v1/docs//tables//rows' |\n jq '\"Matching rows: \" + (.items | length | tostring)'\n# => \"Matching rows: 1\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar query = ':\"Work out\"';\nvar rows = CodaAPI.listRows('', '', {query: query}).items;\nLogger.log('Matching rows: ' + rows.length);\n// => Matching rows: 1\n"}]},"post":{"summary":"Insert/upsert rows","description":"Inserts rows into a table, optionally updating existing rows if any upsert key columns are provided. This endpoint will always return a 202, so long as the doc and table exist and are accessible (and the update is structurally valid). Row inserts/upserts are generally processed within several seconds. Note: this endpoint only works for base tables, not views.\nWhen upserting, if multiple rows match the specified key column(s), they will all be updated with the specified value.\n","operationId":"upsertRows","tags":["Rows"],"parameters":[{"$ref":"#/components/parameters/docId"},{"$ref":"#/components/parameters/tableIdOrName"},{"name":"disableParsing","description":"If true, the API will not attempt to parse the data in any way.","in":"query","example":true,"schema":{"type":"boolean"}}],"requestBody":{"description":"Rows to insert or upsert.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowsUpsert"}}}},"responses":{"202":{"description":"A result indicating that the upsert was queued for processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowsUpsertResult"}}}},"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//tables//rows'\npayload = {\n 'rows': [\n {\n 'cells': [\n {'column': '', 'value': 'Feed Baker'},\n ],\n },\n ],\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'Inserted 1 row')\n# => Inserted 1 row\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' -X POST -H \"Content-Type: application/json\" \\\n -d '{\"rows\": [{\"cells\": [{\"column\": \"\", \"value\": \"Feed Baker\"}]}]}' \\\n 'https://coda.io/apis/v1/docs//tables//rows' |\n jq 'if .statusMessage? == null then \"Inserted 1 row\" else . end'\n# => \"Inserted 1 row\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar body = {\n 'rows': [\n {\n 'cells': [\n {'column': '', 'value': 'Feed Baker'},\n ],\n },\n ],\n};\nCodaAPI.upsertRows('', '', body);\nLogger.log('Inserted 1 row');\n// => Inserted 1 row\n"}]},"delete":{"summary":"Delete multiple rows","description":"Deletes the specified rows from the table or view. This endpoint will always return a 202. Row deletions are generally processed within several seconds.\n","operationId":"deleteRows","tags":["Rows"],"parameters":[{"$ref":"#/components/parameters/docId"},{"$ref":"#/components/parameters/tableIdOrName"}],"requestBody":{"description":"Rows to delete.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowsDelete"}}}},"responses":{"202":{"description":"A result indicating that the delete was queued for processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowsDeleteResult"}}}},"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//tables//rows'\npayload = {\n 'rowIds': ['i-aBcDeFgH', 'i-AbCdEfGh'],\n}\nreq = requests.delete(uri, headers=headers, json=payload)\nreq.raise_for_status() # Throw if there was an error.\nres = req.json()\n\nprint(f'Deleted 2 rows')\n# => Deleted 2 rows\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' -X DELETE -H \"Content-Type: application/json\" \\\n -d '{\"rowIds\": ['i-aBcDeFgH', 'i-AbCdEfGh']}' \\\n 'https://coda.io/apis/v1/docs//tables//rows' |\n jq 'if .statusMessage? == null then \"Deleted 2 rows\" else . end'\n# => \"Deleted 2 rows\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar body = {\n 'rowIds': ['i-aBcDeFgH', 'i-AbCdEfGh'],\n};\nCodaAPI.deleteRows('', '', body);\nLogger.log('Deleted 2 rows');\n// => Deleted 2 rows\n"}]}},"/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}":{"get":{"summary":"Get a row","description":"Returns details about a row in a table.","operationId":"getRow","tags":["Rows"],"parameters":[{"$ref":"#/components/parameters/docId"},{"$ref":"#/components/parameters/tableIdOrName"},{"$ref":"#/components/parameters/rowIdOrName"},{"$ref":"#/components/parameters/useColumnNames"},{"name":"valueFormat","in":"query","description":"The format that cell values are returned as.","schema":{"$ref":"#/components/schemas/ValueFormat"}}],"responses":{"200":{"description":"Info about a row. If this row was retrieved by name, only one matching row will be returned, with no guarantees as to which one it is.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowDetail"}}}},"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//tables//rows/'\nreq = requests.get(uri, headers=headers)\nreq.raise_for_status() # Throw if there was an error.\nres = req.json()\n\nprint(f'Row values are: {\", \".join(str(v) for v in res[\"values\"].values())}')\n# => Row values are: Get groceries, 1, 60\n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' \\\n 'https://coda.io/apis/v1/docs//tables//rows/' |\n jq '.values | map(tostring) | join(\", \")'\n# => \"Get groceries, 1, 60\"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar row = CodaAPI.getRow('', '', '');\nvar values = Object.keys(row.values).map(function(colId) { return row.values[colId]; });\nLogger.log('Row values are: ' + values.join(', '));\n// => Row values are: Get groceries, 1, 60\n"}]},"put":{"summary":"Update row","description":"Updates the specified row in the table. This endpoint will always return a 202, so long as the row exists and is accessible (and the update is structurally valid). Row updates are generally processed within several seconds. When updating using a name as opposed to an ID, an arbitrary row will be affected.\n","operationId":"updateRow","tags":["Rows"],"parameters":[{"$ref":"#/components/parameters/docId"},{"$ref":"#/components/parameters/tableIdOrName"},{"$ref":"#/components/parameters/rowIdOrName"},{"name":"disableParsing","description":"If true, the API will not attempt to parse the data in any way.","in":"query","example":true,"schema":{"type":"boolean"}}],"requestBody":{"description":"Row update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowUpdate"}}}},"responses":{"202":{"description":"A result indicating that the update was queued for processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowUpdateResult"}}}},"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//tables//rows/'\npayload = {\n 'row': {\n 'cells': [\n {'column': '', 'value': 'Get groceries from Whole Foods'},\n ],\n },\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 row {res[\"id\"]}')\n# => Updated row \n"},{"label":"Shell","lang":"shell","source":"curl -s -H 'Authorization: Bearer ' -X PUT -H \"Content-Type: application/json\" \\\n -d '{\"row\": {\"cells\": [{\"column\": \"\", \"value\": \"Get groceries from Whole Foods\"}]}}' \\\n 'https://coda.io/apis/v1/docs//tables//rows/' |\n jq '\"Updated row \" + .id'\n# => \"Updated row \"\n"},{"label":"Google Apps Script","lang":"javascript","source":"// Import the CodaAPI library via Resource->Libraries...:\n// 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl\nCodaAPI.authenticate('');\nvar body = {\n row: {\n cells: [\n {'column': '