Skip to main content
GET
List records

Authorizations

Authorization
string
header
required

Project API key, for server-to-server access to one project.

Headers

X-Hasp-AppId
string

The id of the published app making the request. Required when calling without credentials: anonymous reads are allowed only for an app whose access mode is public, and only for its own project.

Path Parameters

project
string
required

The project's slug or id (ULID).

entity
string
required

The entity slug

Query Parameters

filter
string | null

JSON object of conditions, all ANDed. Per field: {"status":"open"} (equality), {"status":null} (is null), an operator map {"age":{"gte":18,"lt":65}}, or one explicit operator {"age":{"op":"gte","value":18}}. created_at/updated_at accept gt, gte, lt, lte against an ISO 8601 timestamp. A condition that cannot be applied exactly as written is a 422, never ignored.

Operators per field type: see the Data API filtering guide. At most 20 conditions; in takes at most 100 values.

Maximum string length: 8192
sort
string | null

field or field:asc|desc on created_at, updated_at, or a declared non-json field. Nulls sort last ascending and first descending. Default order is by id (creation order).

Maximum string length: 128
cursor
string | null

The meta.next_cursor from the previous page, unchanged. Opaque and encrypted; bound to the sort it was issued for.

Maximum string length: 4096
pageSize
integer

Records per page. Values above the maximum are clamped to it.

Required range: x >= 1

Response

data
EntityRecord · object[]
required
meta
object
required