Skip to main content
GET
Promotion offers

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Query Parameters

sort
enum<string>
Available options:
asc,
desc
field
enum<string>
Available options:
create_date,
expire_date,
finish_date,
is_finished,
subscribe_days
durationMonths
integer
Required range: x > 0
isInactive
enum<string>
Available options:
true,
false,
1,
0
isOnline
enum<string>
Available options:
true,
false,
1,
0
hasRecommenders
enum<string>
Available options:
true,
false,
1,
0
tipAmount
number | null
Required range: x >= 0
totalSpent
number | null

Response

Successful response

claimedOffersCount
number
required
offers
object[]
required
unclaimedOffersCount
number
required
users
object
required