Developers

API reference

Every operation of the OpenRows API (244 operations), generated from its OpenAPI document. The public, versioned API for scripts and integrations is the REST API v1; the other routes are the ones the web app uses.

Authenticate with a personal access token (Authorization: Bearer or_pat_…, created in Settings) or the session cookie. Each operation names the role it needs and the token scope. The machine-readable document is at https://app.openrows.io/api/openapi.json (your own instance serves its own at /api/openapi.json).

Groups

• REST API v129 operations: A base's webhooks (never their secrets), Create a webhook; the answer holds its signing secret, shown only this once, Change, enable or disable a webhook, or rotate its secret (returned once), …
• Airtable5 operations: The Airtable bases an Airtable personal access token can read (workspace creators; the token is not kept), The Airtable imports the caller started in the workspace (the last 7 days), Import Airtable bases into new bases of the workspace, in the background, …
• Attachments3 operations: Announce a file for an attachment field and get a presigned PUT for it, Confirm an upload: the stored object must match the announced size, The workspace's stored files and bytes
• Auth5 operations: The signed-in user and their session, What deleting your account would do to the workspaces you own, Delete your account: signed out everywhere, data hard-deleted within 30 days, …
• Automations11 operations: A base's automations, oldest first (creators and up), Create an automation: a trigger and up to 25 actions, run as you, An automation, …
• Bases10 operations: The plan limits at 80% or more that touch the base: its records and the workspace's other limits (creators and owners), The bases of a workspace the caller can see (a base-only collaborator sees only theirs), Create a base (owners and creators), …
• Comments8 operations: A page of a record's comments, oldest first (the newest page, or before a cursor), Comment on a record (Markdown, @mentions of people with access to the base), Edit your own comment, …
• Extensions7 operations: A base's installed extensions in panel order, Install a built-in extension or a third-party bundle (creators and up), An installed extension's manifest and bundle, …
• Fields9 operations: Add a field, Fields of a table in the trash, most recently deleted first, Restore a field from the trash, …
• Forms5 operations: A public form: its title, description, fields, conditions and settings, A linked record field's picker: records of the form's chosen view, by primary field only, Submit the form: creates one record (once per submissionId), …
• Imports2 operations: Import a CSV (up to 50 MB) into the table, in the background, An import's progress (only who started it)
• Interfaces21 operations: A base's interfaces and pages: creators get drafts and unpublished pages, everyone else published pages only, Create an interface (creators and up), Rename or move an interface, …
• Invitations10 operations: Pending invitations of a workspace (owners and creators), Invite someone by email (owners and creators; only owners invite owners), Send an invitation again with a new token and expiry, …
• Members7 operations: The members of a workspace, The workspace's collaborator directory: members and base-only collaborators of bases the caller can see (emails only for workspace members), Change a member's role (owners and creators; only owners grant or change owner), …
• Notices2 operations: Service notices (Terms, privacy, price and plan changes) the caller hasn't dismissed, Dismiss a service notice's banner for the caller
• Notifications6 operations: Your notifications, newest first (only records you can still read), How many of your notifications are unread, Mark one of your notifications read, …
• Oauth8 operations: The OAuth apps you registered (never their client secrets), Register an OAuth app; the answer is the only time its client secret is shown, Change an OAuth app, or rotate its client secret (answered once), …
• Realtime1 operation: The base's events after since (a seq), oldest first, for realtime catch-up; 410 when since is older than the 7-day retention
• Records9 operations: Live records, oldest first, keyset-paged, Create one record ({ fields }) or up to 1,000 ({ records }), Patch up to 1,000 records in one transaction, …
• Regions2 operations: The regions workspaces can live in, and whether the caller may create one elsewhere, Create a workspace in another region's stack, owned by the caller (Enterprise owners)
• Revisions2 operations: A record's revision history, newest first (fields the caller can't read left out), Restore the record (or one cell) to how it was right after a revision
• Scripts5 operations: A base's saved scripts by name (editors and up), Save a new script (creators and up), A saved script (editors and up), …
• Shared4 operations: What the share link shows: its name, the views it opens and its toggles, Enter a share link's password; sets a cookie for this link (12 hours at most), A shared view: its name, visible fields and layout, …
• Shares8 operations: The view's share links (not revoked), newest first, Make a read-only share link of the view; its token is answered only here, Change a view share link's expiry, password, domains or toggles, …
• Snapshots6 operations: A base's snapshots, newest first, and the workspace's retention (creators and up), Take a snapshot of a base now (schema, records, links, attachment references), Restore a snapshot to a new base of the same workspace (never in place), in the background, …
• Syncs9 operations: Add a table synced from a table or view you can read (creators and up), Preview a CSV URL, Postgres or connector source (creators and up), List a sync connector's items with your connected account (creators and up), …
• Tables6 operations: The tables of a base, Create a table with the default fields and a grid view, Read a table with its live fields, …
• Templates3 operations: The built-in templates of the gallery, without their records, A built-in template in the template format: its tables, fields, views and records, Create a base from a built-in template (owners and creators)
• Tokens3 operations: The caller's personal access tokens (never their secrets), Create a personal access token; the answer is the only time its secret is shown, Revoke a personal access token
• Trash11 operations: Bases of a workspace in the trash (creators and up), Restore a base from the trash, Delete a base in the trash permanently, with everything in it, …
• Views10 operations: The views of a table, in sidebar order, Create a view, Read a view, …
• Workspaces17 operations: The caller's workspaces, with their role in each (null where they collaborate on some bases only), Create a workspace (the caller becomes its owner), Read a workspace, …