API reference

Revisions

2 operations, generated from the OpenAPI document.

A record's revision history, newest first (fields the caller can't read left out)

GET /api/tables/{tableId}/records/{recordId}/revisions

Access: record:read on the table (see ACTIONS for the minimum role); personal access tokens need data.records:read.

Parameters

NameInTypeRequired
tableIdpathstringyes
recordIdpathstring (uuid)yes
cursorquerystringno
limitqueryintegerno

Responses

  • 200 Success
    • revisions array of object required
      • id string (uuid) required
      • recordId string (uuid) required
      • kind "created" | "updated" | "deleted" | "restored" required
      • actorId string (uuid) | null required
      • via "form" | "automation" | null required
      • at string (date-time) required
      • changes array of object required
        • fieldId string (uuid) required
        • type string required
        • before any required
        • after any required
      • restoredFrom string (uuid) | null required
    • nextCursor string | null required
  • 401 Not signed in
  • 403 Signed in, but the role is too low
  • 404 No such resource, or no access to it
  • 422 The request failed validation
  • 429 Too many requests: a rate limit was reached (see Retry-After)

Restore the record (or one cell) to how it was right after a revision

POST /api/tables/{tableId}/records/{recordId}/revisions/{revisionId}/restore

Access: record:update on the table (see ACTIONS for the minimum role); personal access tokens need data.records:write.

Parameters

NameInTypeRequired
tableIdpathstringyes
recordIdpathstring (uuid)yes
revisionIdpathstring (uuid)yes

Request body

  • fieldId string (uuid)
  • clientOpId string

Responses

  • 200 Success
    • id string (uuid) required
    • tableId string (uuid) required
    • version integer required
    • fields object required
    • createdAt string (date-time) required
    • createdBy string (uuid) | null required
    • updatedAt string (date-time) required
    • updatedBy string (uuid) | null required
  • 401 Not signed in
  • 403 Signed in, but the role is too low
  • 404 No such resource, or no access to it
  • 422 The request failed validation
  • 429 Too many requests: a rate limit was reached (see Retry-After)