Skip to main content
GET
List entity records by cursor

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app that owns the entity.

entity_name
string
required

Name of the entity, exactly as List entity schemas reports it. Don't pass User here. It doesn't fail, but it reads and writes a separate, disconnected set of records stored under that name, not the app's real user accounts, which are managed through their own endpoints.

Query Parameters

q
string

Filter as a JSON object of field names and values, for example {"status": "paid"} for an exact match, or using an operator such as $gt for a comparison. See Filtering, sorting, and paging for a full list of operators.

limit
integer
default:100

Number of records on each page, from 1 to 5000, or up to 1000 with distinct. Defaults to 100, and a higher value is treated as the maximum.

sort
string
default:-created_date

Single field to sort by, prefixed with - for descending. For example, -created_date returns newest first. Defaults to -created_date. Sort by a field every record carries, such as created_date, or by one the entity's schema declares as a string, number, integer, or boolean.

fields
string

Comma-separated list of fields to return, which reduces the response size on a wide entity. Reach a field inside an object with dots, as in customer.email. Each record still carries its id whether you ask for it or not.

cursor
string

Pagination cursor from previous response. Leave it out for the first page.

distinct
string

Field whose distinct values to return instead of records, in ascending order.

Response

One page of the entity's records.

One page of records and the cursor for the next one.

items
(EntityRecord · object | string | number | boolean)[]
required

The page's records in the requested sort order, or with distinct the field's values in ascending order.

One record in one of an app's entities.

Example:
next_cursor
string | null
required

Cursor for fetching the next page. The value is null if there are no more pages.

Example:

"gAAAAABn7vJ..."

has_more
boolean
required

Whether there are more items to fetch.

Example:

true