List records
List records in an object. Filter by property (filter[key]=value), sort, full-text q search, and offset or cursor pagination (follow nextCursor). Requires scope: records:read.
Authorizations
A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.
Path Parameters
The object to list — its id, key, or name.
Query Parameters
Max records to return (1–200). Defaults to 50.
1 <= x <= 200How many records to skip (offset pagination). Defaults to 0.
x >= 0Filter by property: filter[key]=value (exact) or filter[key][op]=value (op ∈ eq/neq/gt/lt/gte/lte/contains/notContains/startsWith/endsWith/empty/notEmpty). Multiple properties AND together.
Sort by a property key (or created_at/updated_at), e.g. amount:desc.
Full-text search. Relevance-ranked; ignores filter/sort/cursor when set.
Pagination token from a previous response cursor. Mutually exclusive with offset.