v1

latestOpenAPI 3.0.32026-07-17214860.6 KB
Records

Query Records

Fetch records using a query with filters and sorting options

post/database/{version}/{container}/{environment}/{database}/records/query

Path parameters

versionstring required

Protocol version

containerstring required

Container ID (begins with "iCloud.")

environment'development' | 'production' required

Container environment

database'public' | 'private' | 'shared' required

Database scope

Request body

resultsLimitinteger

Maximum number of records to return

desiredKeysstring[]

List of field names to return

continuationMarkerstring

Marker for pagination

zoneWideboolean

If true, query across all zones rather than a single zone.

numbersAsStringsboolean

If true, return numeric field values as strings to avoid JavaScript precision loss (relevant for INT64).

Response

Successful query

continuationMarkerstring
All 21 operations