You didn’t think we’d be in Beta forever, did you?
When we introduced our API capabilities (first via Zapier, and then via our Beta API offering), we wanted to make sure developers could maximize Coda’s powerful features with their third party applications and data sources. Since then, our product has changed a bit and we’ve received a lot of useful feedback on our API.
Today, we’re excited to introduce the official Coda API v1.
If you want to jump right to migrating your current API implementations, you can access our Migration Guide at https://coda.io/api-migration-guide.
So what’s changing?
In addition to making the API simpler to use and more powerful, some other important changes include:
- A new endpoint: Endpoints that modify docs now return a request id, which you can pass to https://coda.io/apis/v1/mutationStatus/ to check if an update that was queued for processing has been applied
- Endpoints for tables and views have merged: Previously, you had to use a separate endpoint to get or modify a view than you would for a table. In the v1 API, you can pass a view id to the shared /tables/ endpoint
- Sections are now pages: Since we’ve launched pages and deprecated folders and sections, endpoints for folders and sections have been removed and consolidated into a new set of endpoints for pages. To find nested sections you previously had to make a request to a folders endpoint; now you can examine page objects for children and parent properties
- Pagination is simpler: To get the next page of results, pass the nextPageToken from the previous page as the pageToken for your next request. There’s no need to pass any other parameters. (This is now the only way to get more results.)
v1beta1should be replaced with
v1in your API URLs
Note that Zapier integrations and Cross-doc actions in Coda are indeed powered by the API, but no action is needed on your end to update such applicationsーwe’re taking care of that behind the scenes.
If you use the Google Apps Script, we recommend reviewing the Google Apps Script Migration section of the Migration Guide to plan your changes.
As stated in our Beta API documentation, we’re observing a 4 week (30 day) period to make changes before turning down our Beta API instance. We’ll be reaching out via email to affected customers next week and the 30 day migration period will start then. If you’ll require more time to make changes, please contact us at firstname.lastname@example.org. Now that we’re out of Beta, the V1 API will be supported for at least 6 months (through at least January 15, 2021) and we’ll provide at least 3 months notice before making breaking changes on or after that date.