v1

latestOpenAPI 3.0.32026-07-17214860.6 KB

Records

Fetch Record Changes

Get all record changes relative to a sync token

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

versionstring required

Protocol version

containerstring required

Container ID (begins with "iCloud.")

environment'development' | 'production' required

Container environment

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

Database scope

syncTokenstring

Token from previous sync operation

resultsLimitinteger

desiredKeysstring[]

List of field names to limit the fields returned per changed record.

desiredRecordTypesstring[]

List of record-type names to limit the change feed to specific record types.

Changes retrieved successfully

syncTokenstring

moreComingboolean