Skip to main content

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Synchronize App State changes​

Pulls a bounded page after an opaque sync token. Apply the page and nextSyncToken atomically; drain until hasMore is false. On 410, preserve pending mutations, bootstrap, drain, replay, then pull again. Requires a user-delegated access token with app_state or app_state.read. Client-credentials tokens are rejected because App State is always scoped to a real user.

Query Parameters
    since string required

    Opaque nextSyncToken returned by bootstrap or the preceding changes page.

    Example: v2.opaque-sync-token
    limit integer

    Default value: 100

    Maximum rows or changes scanned. Invalid or non-positive values use 100; values above 100 are capped at 100.

    Example: 50
Responses

A bounded page of changes and the token for the next pull.

Schema
    success boolean required

    Possible values: [true]

    data object required
    changes object[] required
  • Array [
    • collection string required

    Possible values: Value must match regular expression ^[a-z0-9][a-z0-9._-]{0,79}$

    Enabled data group containing the document.

    key string required

    Possible values: non-empty and <= 512 characters, Value must match regular expression ^(?=(?:(?:[\uD800-\uDBFF][\uDC00-\uDFFF]|[^\uD800-\uDFFF])){1,512}$)[^\u0000-\u001f\u007f/\\]+$

    Document key within the data group.

    schemaVersion integer required

    Possible values: >= 1 and <= 2147483647

    Application-owned schema version for the document value.

    version integer required

    Possible values: >= 1

    Server-assigned document version.

    updatedAt date-time required
    value required

    Application-owned JSON value. The service never merges document fields.

    etag string required

    Possible values: Value must match regular expression ^(?:W\/)?"[A-Za-z0-9_-]{43}"$

    Opaque quoted ETag. Store and send it unchanged in If-Match; never construct it from version.

    operation string required

    Possible values: [upsert, delete]

    Change operation to apply to the local document.

  • ]
    • nextSyncToken string required
    hasMore boolean required
Loading...