API reference

Realtime

1 operation, generated from the OpenAPI document.

The base's events after since (a seq), oldest first, for realtime catch-up; 410 when since is older than the 7-day retention

GET /api/bases/{baseId}/events

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

Parameters

NameInTypeRequired
baseIdpathstringyes
sincequeryintegeryes
limitqueryintegerno

Responses

  • 200 Success
    • events array of object required
      • seq integer required
      • baseId string (uuid) required
      • tableId string (uuid) | null required
      • kind string required
      • payload object required
      • actorId string (uuid) | null required
      • clientOpId string | null required
      • at string (date-time) required
    • next integer required
    • hasMore boolean 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)