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 the active App State configuration​

Returns enabled data groups and effective limits for the authenticated OAuth client. Call it before writing so the app knows which names are available and which require ETag preconditions. Requires a user-delegated access token with app_state, app_state.read, or app_state.write. Client-credentials tokens are rejected because App State is always scoped to a real user.

Responses

Active data groups and effective limits for this client.

Schema
    success boolean required

    Possible values: [true]

    data object required
    configVersion integer required

    Possible values: >= 1

    Monotonic policy version used to detect configuration changes.

    limits object required

    Effective App State limits for this client and environment.

    quotaBytesPerUser integer required

    Possible values: >= 1

    maxDocumentBytes integer required

    Possible values: >= 1

    maxDocumentsPerUser integer required

    Possible values: >= 1

    changeRetentionDays integer required

    Possible values: >= 1

    collections object[] required

    Enabled data groups. Use only names returned here.

  • Array [
    • name 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.

    requiresPrecondition boolean required

    Whether mutations require an ETag precondition.

    maxDocumentsPerUser integer required

    Possible values: >= 1

    Effective per-user limit for this data group.

  • ]
Loading...