Skip to main content
GET
Get App Data
Reads one record by key, or lists your app’s records. Expired records are never returned.
App data is authenticated with your app’s client credentials, not a store’s access token — so your app can read what it stored (for example a store’s access token) before it has a token to use:
Records are private to your app. storeId is a partition you choose: pass the store’s id to keep a record per store, or omit it for app-wide records.

Request

Query Parameters

string
Read the record with exactly this key. Without key, records are listed.
string
The store partition. Omit to read app-wide records.
string
1 to read across every store partition (for example to iterate all stores in a scheduled job). Overrides storeId.
string
When listing: only records whose key starts with this text.
integer
default:"50"
When listing: records per page (maximum 250).
integer
default:"0"
When listing: records to skip.

Response

With key: the record under data.record (404 when there is none). Without key: data.records (most recently written first), data.total, data.limit and data.offset.
string
The record’s key
string
The store partition, or null for an app-wide record
any
The stored JSON value
string
When the record expires (ISO 8601), or null
string
Last write (ISO 8601)

Errors