Skip to main content
GET
List records

Authorizations

Authorization
string
header
required

An admin application key: Authorization: Api-Key <token> (or legacy x-api-key). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.

Path Parameters

orgId
string
required

The organization (tenant) id. Must equal the tenant of the admin key.

listId
string
required

The custom list id.

Query Parameters

version_id
string

Read a published version instead of the working set.

status
enum<string>

Filter by record status.

Available options:
active,
archived
q
string

Search term, at most 256 characters.

Maximum string length: 256
limit
integer

Page size, 1 to 1000.

Required range: 1 <= x <= 1000
offset
integer

Zero-based offset.

Required range: x >= 0

Response

Success

{ data: CustomListRecordsPage }

data
object
required