Skip to main content
GET
List the app's values

Authorizations

Authorization
string
header
required

An app access token from POST /apps/oauth/token, valid 1 hour. An offline token acts as the app; an online token acts as the app on behalf of one dashboard user (the intersection of both permission sets).

Query Parameters

ownerType
enum<string>
Available options:
business,
store,
product,
order,
customer
ownerId
string

An id (a string of digits).

Pattern: ^\d{1,24}$
key
string

A key: a lowercase letter, then up to 63 lowercase letters, digits or underscores.

Pattern: ^[a-z][a-z0-9_]{0,63}$
fields
string

Return only these top-level fields, separated by commas; the id is always kept. The response schema describes the whole resource. An unknown name is 400 INVALID_FIELDS. Fields: id, ownerType, ownerId, key, value, visibility, declared, createdAt, updatedAt.

Maximum string length: 1000
limit
integer

Page size, 1 to 100 (default 50). A value outside that range is 400, never clamped.

Required range: 1 <= x <= 100
cursor
string

The nextCursor of the previous page, unchanged, with the same filters. Opaque; bound to this list and its filters (400 INVALID_CURSOR otherwise).

Maximum string length: 512

Response

A page of values.

One page, newest first. Pass nextCursor back as cursor for the next one.

data
object[]
required
nextCursor
string | null
required

Null on the last page.