Skip to main content
GET
List a custom object's records

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

object
string
required

The custom object's key, as GET /v1/objects lists it

Required string length: 1 - 200

Query Parameters

fields
string[] | null

Custom field keys to return (comma-separated); all of them when omitted

limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string | null

next_cursor from the previous page

filter
object

Filter with query parameters filter[<key>][<op>]=<value>, all ANDed; in and nin take the parameter repeated.

Operators: eq, neq, gt, gte, lt, lte, in, nin, contains, not_contains, starts_with, ends_with, exists, not_exists.

Response

200 - application/json

Successful Response

data
CustomObjectRecord · object[]
required
has_more
boolean
default:false
next_cursor
string | null