Files

3.6 KiB

Coda Routing Reference

App name: coda Base URL proxied: coda.io/apis/v1

API Path Pattern

/coda/apis/v1/{resource}

Common Endpoints

Account

Get Current User

GET /coda/apis/v1/whoami

Docs

List Docs

GET /coda/apis/v1/docs

Create Doc

POST /coda/apis/v1/docs

Get Doc

GET /coda/apis/v1/docs/{docId}

Delete Doc

DELETE /coda/apis/v1/docs/{docId}

Pages

List Pages

GET /coda/apis/v1/docs/{docId}/pages

Create Page

POST /coda/apis/v1/docs/{docId}/pages

Get Page

GET /coda/apis/v1/docs/{docId}/pages/{pageIdOrName}

Update Page

PUT /coda/apis/v1/docs/{docId}/pages/{pageIdOrName}

Delete Page

DELETE /coda/apis/v1/docs/{docId}/pages/{pageIdOrName}

Tables

List Tables

GET /coda/apis/v1/docs/{docId}/tables

Get Table

GET /coda/apis/v1/docs/{docId}/tables/{tableIdOrName}

Columns

List Columns

GET /coda/apis/v1/docs/{docId}/tables/{tableIdOrName}/columns

Get Column

GET /coda/apis/v1/docs/{docId}/tables/{tableIdOrName}/columns/{columnIdOrName}

Rows

List Rows

GET /coda/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows

Get Row

GET /coda/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}

Insert/Upsert Rows

POST /coda/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows

Update Row

PUT /coda/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}

Delete Row

DELETE /coda/apis/v1/docs/{docId}/tables/{tableIdOrName}/rows/{rowIdOrName}

Formulas

List Formulas

GET /coda/apis/v1/docs/{docId}/formulas

Get Formula

GET /coda/apis/v1/docs/{docId}/formulas/{formulaIdOrName}

Controls

List Controls

GET /coda/apis/v1/docs/{docId}/controls

Get Control

GET /coda/apis/v1/docs/{docId}/controls/{controlIdOrName}

Permissions

Get Sharing Metadata

GET /coda/apis/v1/docs/{docId}/acl/metadata

List Permissions

GET /coda/apis/v1/docs/{docId}/acl/permissions

Add Permission

POST /coda/apis/v1/docs/{docId}/acl/permissions

Delete Permission

DELETE /coda/apis/v1/docs/{docId}/acl/permissions/{permissionId}

Categories

List Categories

GET /coda/apis/v1/categories

Utilities

GET /coda/apis/v1/resolveBrowserLink?url={encodedUrl}

Get Mutation Status

GET /coda/apis/v1/mutationStatus/{requestId}

Analytics

List Doc Analytics

GET /coda/apis/v1/analytics/docs

List Pack Analytics

GET /coda/apis/v1/analytics/packs

Get Analytics Update Time

GET /coda/apis/v1/analytics/updated

Query Parameters

Common parameters across endpoints:

  • limit - Page size (max: 200)
  • pageToken - Cursor for pagination
  • query - Search filter
  • useColumnNames - Use column names vs IDs (rows)
  • valueFormat - simple, simpleWithArrays, rich (rows)

Notes

  • Mutations (create/update/delete) return HTTP 202 with requestId
  • Use /mutationStatus/{requestId} to check completion
  • Newly created docs need a moment before child resources are accessible
  • Table/column names can be used instead of IDs
  • Row operations require base tables, not views
  • Page-level analytics require Enterprise plan

Resources