Skip to main content
GET
List buyer access
Returns a paginated list of buyer access records, newest first, under data.access. Filter by product, status (active, expired or revoked) and email. Requires the READ_INVENTORY scope.
The response includes buyers’ email addresses, and it is gated by READ_INVENTORY alone: there is no separate customer scope on this endpoint. Treat the data accordingly and only request the scope when your app needs it.
status is the effective one: a pass past its end date reads as expired even before the nightly sweep has marked it. data.failedGrants lists paid orders whose access could not be granted yet; see Retry failed grants.
These endpoints only work on a store whose type is digital. On any other store they return 403 with This is only available on digital stores. See Digital stores.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side , never send a shop id.

Query Parameters

page
integer
default:1

Page number (1-based).

Required range: x >= 1
limit
integer
default:20

Items per page, 1 to 100.

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

Only records for this digital product (ObjectId).

status
enum<string>

Filter by effective status.

Available options:
active,
expired,
revoked
email
string

Partial, case-insensitive match on the buyer's email (max 120 characters).

Response

List buyer access: success.

status
integer
required
Example:

200

success
boolean
required
Example:

true

message
string
required
Example:

"Access records retrieved successfully"

data
object
required
Example: