Skip to main content
GET
/
v1
/
rewards
List rewards
curl --request GET \
  --url https://api.oneofnone.io/v1/rewards \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "value": 123,
      "minimumPurchase": 123,
      "minimumQuantity": 123,
      "usageLimitTotal": 123,
      "usageLimitPerCustomer": 123,
      "startsAt": "<string>",
      "expiresAt": "<string>",
      "stackable": true,
      "globalCode": "<string>",
      "externalUrl": "<string>",
      "imageId": 123,
      "conditions": {},
      "totalRedemptions": 123,
      "totalRevenueImpact": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "image": {
        "id": 123,
        "url": "<string>"
      },
      "externalIds": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "rewardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "externalId": "<string>",
          "externalCodeId": "<string>",
          "syncedAt": "<string>",
          "error": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "access": {
        "qualifies": true,
        "reasons": [
          "<string>"
        ]
      }
    }
  ],
  "pagination": {}
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
status
Available options:
draft,
active,
paused,
expired,
archived
​
type
enum<string>
Available options:
DISCOUNT,
GATED_CONTENT,
FREE_CLAIM,
EARLY_ACCESS,
CREDIT
​
scope
enum<string>
Available options:
sitewide,
collection,
product,
variant
​
limit
number
Required range: 1 <= x <= 1000
​
offset
number
​
order
enum<string>
Available options:
asc,
desc
​
order_by
string
​
include_count
boolean

Response

200 - application/json

Successful response

​
data
object[]
required
​
pagination
object
required