Skip to main content
GET
List records

Authorizations

Authorization
string
header
required

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

object
string
required

The object to list — its id, key, or name.

Query Parameters

limit
integer
default:50

Max records to return (1–200). Defaults to 50.

Required range: 1 <= x <= 200
offset
integer
default:0

How many records to skip (offset pagination). Defaults to 0.

Required range: x >= 0
filter
object

Filter 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
string

Sort by a property key (or created_at/updated_at), e.g. amount:desc.

q
string

Full-text search. Relevance-ranked; ignores filter/sort/cursor when set.

cursor
string

Pagination token from a previous response cursor. Mutually exclusive with offset.

Response

A page of records.

data
object

A page of records.

reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"