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 for pagination.

perPage
integer

Number of items per page.

sortField
string

Field name to sort by. Use 'performance' for performance-based sorting.

sortDirection
enum<string>

Sort direction.

Available options:
asc,
desc

Search by offer title or external ID.

exact
string

Exact match search.

status
enum<string>

Filter by offer status. One value only — a comma-separated list is not supported and falls back to the unfiltered list, as does any unrecognised value (200, no error). Deleted offers cannot be filtered for. draft additionally depends on permissions: a key that may not create offers gets this filter intersected with the non-draft statuses, so the result is always an empty list — indistinguishable from having no drafts.

Available options:
active,
testing,
inactive,
draft
visible_type
string

Filter by visibility type (comma-separated).

advertisers
string

Filter by advertiser IDs (comma-separated).

categories
string

Filter by category IDs (comma-separated).

countries
string

Filter by geoname IDs (comma-separated).

goalsTypes
string

Filter by goal type IDs (comma-separated).

onlyNew
string

Filter new offers only.

Filter featured offers only.

tags_ids
string

Filter by tag IDs (comma-separated).

traffic_types_ids
string

Filter by traffic type IDs (comma-separated).

currencies
string

Filter by currency codes (comma-separated).

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