Skip to content

Offers, active and paused unless status says

GET
/v1/buyer/offers
curl --request GET \
--url 'https://example.com/v1/buyer/offers?sort=id' \
--header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. API keys with the buyer:read or buyer:write scope.

page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

sort
string

Comma-separated fields, each with - for descending

status
string
network_id
string
tag
string
q
string

OK

Media typeapplication/json
object
data
required
Array<object>
object
country
required
string
created_at
required
string format: date-time
daily_cap
required
integer format: int64
direct
required
boolean
fallback_offer
required
Any of:
object
id
required
integer format: int64
name
string
id
required
integer format: int64
import_key
required
string
name
required
string
network
required
object
id
required
integer format: int64
name
string
origin
required
string
payout
required
Any of:
object
amount_micros
required
integer format: int64
currency
required
string
payout_mode
required
string | null
Allowed values: postback fixed
sequence
required
integer format: int64
status
required
string | null
Allowed values: active paused archived
tags
required
Array<string>
updated_at
required
string format: date-time
url
required
string
workspace_id
required
integer format: int64
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example

{
"data": [
{
"payout_mode": "postback",
"status": "active"
}
]
}

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
"error": {
"code": "example",
"fields": {
"additionalProperty": "example"
},
"message": "example"
}
}