Skip to main content
GET
List records of an object

Authorizations

x-api-key
string
header
required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Path Parameters

object
string
required

Query Parameters

limit
integer

1-100. Defaults to 25. Out-of-range values are clamped.

cursor
string

Opaque cursor from a previous response.

filter
string

JSON filter. A condition is {"field":..,"op":..,"value":..}; groups are {"and":[..]} or {"or":[..]}, nested at most 3 deep. Operators: eq, neq, gt, gte, lt, lte, contains, in, is_null. An unknown field returns 400 naming it.

sort
string

Comma-separated field names, at most 3. Prefix with - for descending, e.g. -created_at,name.

Response

Records retrieved

success
enum<boolean>
Available options:
true
data
object
meta
object