List records

View as Markdown

Lists live records for a project-scoped object, optionally driven by a saved view (?view) or ad-hoc ?filter/?sort. Paginated (keyset for the default sort, offset for custom sorts). Requires data-record:read on the project.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

projectIdstringRequired
The parent project id.
objectIdstringRequired

The project-scoped object definition id.

Query parameters

viewstringOptional

A saved view id whose filters/sorts drive the query.

filterstringOptional

Ad-hoc filter: a JSON array of filter entries.

sortstringOptional

Ad-hoc sort: a JSON array of sort entries.

limitintegerOptional1-200Defaults to 50
Maximum number of records to return.
cursorstringOptional

Pagination cursor from a previous page’s nextCursor.

Response

A page of records.
recordslist of maps from strings to any
nextCursorstring or null
Pagination cursor for the next page, or null.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error