API ESSENTIALS

Response statuses

Understand each status and what to do next.

Common read responses

Common statuses from the identity endpoint. Other endpoints may document additional responses.

200

The resource. An unauthorized/absent resource is 404; an RLS-empty relation is null.

Read the response body.
400

Malformed request — unknown field/filter/include, validation error, bad id or body.

Check the request fields, parameters and values.
401

Missing or invalid credentials.

Check that your credential is valid and has not expired or been revoked.
403

Workspace or member API approval is missing, workspace access is disabled, or membership is unavailable.

Check workspace approval, the workspace API switch and member access.
404

Resource not found or not visible under RLS.

Check the identifier and whether the user can access the record.
429

Rate limit exceeded (120 reads/min; 30 writes/min — separate buckets).

Respect Retry-After and wait before sending another request.

Error envelope

The uniform error envelope. `error.code` is stable and greppable — match on it, never on the message text.

error.codestring

A stable identifier for handling the failure.

error.messagestring

A readable explanation of the failure.

API reference
Public documentation

Sign in to check your workspace’s API access.

Check access

Explore the API