Skip to main content
GET
List offers

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Query Parameters

page
integer

Page number.

perPage
integer

Items per page.

sortField
string

Sort field.

sortDirection
enum<string>

Sort direction.

Available options:
asc,
desc

Search by text or ID.

fields
string

Comma-separated list of top-level response fields to return, e.g. fields=id,status,targeting. When omitted, the full field set for your role is returned. Unknown field names are ignored silently — the response still returns 200 with the recognised fields only. Not supported on the reporting endpoints: those select their payload with columns instead.

Response

Offers list.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object