REST API reference

Plain HTTP, JSON in and out. Every endpoint below is authenticated the way Authentication describes, and every one of them is real — copied from the routes the server actually registers, not an aspirational surface.

Conventions

Every list and single-object response wraps its payload under a named key, never a bare array or object — { workspaces: [...] }, { record: {...} }. Unwrap that one field rather than assuming the response body itself is the array.

IDs are 24-character Mongo ObjectIds throughout. A path with two id segments (/records/:recordId/sub-records) addresses a nested resource through its parent; everything else is addressed directly by its own id once you have it.

Resources

Workspaces

GETPOSTPUTDELETE

The top-level container everything else — modules, members, activity — hangs off.

Workspace members

GETPOSTPUTDELETE

Who belongs to a workspace, their role, and invitations.

Module access

GETPUT

Per-person grants on private modules — separate from workspace role, which only decides whether a grant is even necessary.

Modules

GETPOSTPUTDELETE

Boards — the unit a workspace is organized into. Modules hold collections, columns and records.

Collections

GETPOSTPUTDELETE

The groups a module's records are split into — the rows a board's grid is grouped under.

Columns

GETPOSTPUTDELETE

The shape of a module's grid — one definition per field every record in the module carries.

Records

GETPOSTPUTDELETE

Rows — the items a collection holds, and the sub-records that hang one level off them.

Record values

GETPOSTPUTDELETE

Cell values — one row per (record, column) pair, plus the resolved view of every reference/mirror column on a module.

Amendments

GETPOSTPUTDELETE

The conversation on a record — what the product calls an "update" posted underneath it.

Activity

GETPOST

The audit feed — every write in a workspace, including what an automation did, cursor-paged.

Automations

GETPOSTPUTDELETE

Recipes: WHEN a trigger fires, ONLY IF its conditions hold, THEN run its actions. Scoped to one module, or to every module in a workspace.

Notifications

GETPATCHPOSTDELETE

The caller's own notification feed — mentions, assignments, invites, status changes.

API keys (PIT)

GETPOST

The Personal Integration Token — the credential this whole reference authenticates with. See Authentication for how to use it.