Skip to main content

User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

Get an App State document​

Returns one live document and its quoted ETag. Send the ETag unchanged in If-Match for a strict replacement. 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.

Path Parameters
    collection string required

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

    Enabled data-group name returned by GET /v1/app-state:config.

    Example: settings
    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/\\]+$

    Application-defined document key of 1-512 Unicode scalar values. Keys are compared by exact code points without Unicode normalization, so canonically equivalent spellings are distinct keys. It cannot contain slashes, backslashes, or control characters.

    Example: theme
Responses

The current live document.

Response Headers
  • ETag string
    Example: "s_6UYAfR2WOsf0gHaRMUXBw2kP1S-kRXyCmbCl6yZpk"

    Opaque quoted document validator. An intermediary may add W/. Store it and send it unchanged in If-Match; never construct it from version.

Schema
    success boolean required

    Possible values: [true]

    data object required
    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.

Loading...