List buyer access
curl --request GET \
--url https://api.salesive.com/api/v1/digital-access \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.salesive.com/api/v1/digital-access"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salesive.com/api/v1/digital-access', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salesive.com/api/v1/digital-access",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.salesive.com/api/v1/digital-access"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.salesive.com/api/v1/digital-access")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/digital-access")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 200,
"success": true,
"message": "Access records retrieved successfully",
"data": {
"access": [
{
"_id": "6702d3f0e1b3a40012cd3001",
"email": "ada@example.com",
"user": "66f0aa11e1b3a40012ef0001",
"scope": "product",
"product": {
"_id": "6702c1a4e1b3a40012cd2001",
"name": "The Lagos Cookbook"
},
"kind": "pass",
"status": "active",
"source": "granted",
"startsAt": "2026-10-12T08:00:00.000Z",
"accessUntil": "2026-11-11T08:00:00.000Z",
"daysLeft": 30,
"autoRenew": {
"enabled": false,
"cardLast4": null,
"cardBrand": null
},
"revokedAt": null,
"revokedReason": "",
"createdAt": "2026-10-12T08:00:00.000Z",
"updatedAt": "2026-10-12T08:00:00.000Z"
}
],
"pagination": {
"total": 1,
"page": 1,
"limit": 20,
"pages": 1,
"hasNext": false,
"hasPrev": false,
"nextPage": null,
"prevPage": null
},
"failedGrants": []
}
}{
"status": 400,
"success": false,
"message": "A one-time price is required",
"data": {}
}{
"status": 401,
"success": false,
"message": "App token expired or invalid.",
"data": {}
}{
"status": 403,
"success": false,
"message": "This app is missing the required permission(s): WRITE_INVENTORY",
"data": {}
}Digital access
List buyer access
Returns the store’s buyer access records, newest first.
GET
/
digital-access
List buyer access
curl --request GET \
--url https://api.salesive.com/api/v1/digital-access \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.salesive.com/api/v1/digital-access"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.salesive.com/api/v1/digital-access', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salesive.com/api/v1/digital-access",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.salesive.com/api/v1/digital-access"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.salesive.com/api/v1/digital-access")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salesive.com/api/v1/digital-access")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 200,
"success": true,
"message": "Access records retrieved successfully",
"data": {
"access": [
{
"_id": "6702d3f0e1b3a40012cd3001",
"email": "ada@example.com",
"user": "66f0aa11e1b3a40012ef0001",
"scope": "product",
"product": {
"_id": "6702c1a4e1b3a40012cd2001",
"name": "The Lagos Cookbook"
},
"kind": "pass",
"status": "active",
"source": "granted",
"startsAt": "2026-10-12T08:00:00.000Z",
"accessUntil": "2026-11-11T08:00:00.000Z",
"daysLeft": 30,
"autoRenew": {
"enabled": false,
"cardLast4": null,
"cardBrand": null
},
"revokedAt": null,
"revokedReason": "",
"createdAt": "2026-10-12T08:00:00.000Z",
"updatedAt": "2026-10-12T08:00:00.000Z"
}
],
"pagination": {
"total": 1,
"page": 1,
"limit": 20,
"pages": 1,
"hasNext": false,
"hasPrev": false,
"nextPage": null,
"prevPage": null
},
"failedGrants": []
}
}{
"status": 400,
"success": false,
"message": "A one-time price is required",
"data": {}
}{
"status": 401,
"success": false,
"message": "App token expired or invalid.",
"data": {}
}{
"status": 403,
"success": false,
"message": "This app is missing the required permission(s): WRITE_INVENTORY",
"data": {}
}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.curl -X GET https://api.salesive.com/api/v1/digital-access?status=active&limit=20 \
-H "Authorization: Bearer app_<your-app-access-token>"
Authorizations
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 number (1-based).
Required range:
x >= 1Items per page, 1 to 100.
Required range:
1 <= x <= 100Only records for this digital product (ObjectId).
Filter by effective status.
Available options:
active, expired, revoked Partial, case-insensitive match on the buyer's email (max 120 characters).
Response
List buyer access: success.
Example:
200
Example:
true
Example:
"Access records retrieved successfully"
Show child attributes
Show child attributes
Example:
{ "access": [ { "_id": "6702d3f0e1b3a40012cd3001", "email": "ada@example.com", "user": "66f0aa11e1b3a40012ef0001", "scope": "product", "product": { "_id": "6702c1a4e1b3a40012cd2001", "name": "The Lagos Cookbook" }, "kind": "pass", "status": "active", "source": "granted", "startsAt": "2026-10-12T08:00:00.000Z", "accessUntil": "2026-11-11T08:00:00.000Z", "daysLeft": 30, "autoRenew": { "enabled": false, "cardLast4": null, "cardBrand": null }, "revokedAt": null, "revokedReason": "", "createdAt": "2026-10-12T08:00:00.000Z", "updatedAt": "2026-10-12T08:00:00.000Z" } ], "pagination": { "total": 1, "page": 1, "limit": 20, "pages": 1, "hasNext": false, "hasPrev": false, "nextPage": null, "prevPage": null }, "failedGrants": [] }
Was this page helpful?

