Skip to main content
POST
Retrieve a paginated list of offers. Supports search filters, sorting, and pagination to help you find and browse offers programmatically. Use query parameters page and page_size to control pagination. Supports the relationship query parameter with the following values: visibility, ruleset, tracking_domain, urls, affiliate_tier, account_manager, sales_manager, dmo.

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Query Parameters

page
integer
default:1

Page number (1-based).

page_size
integer
default:50

Number of results per page (max 2000).

Required range: x <= 2000
relationship
enum<string>

Include related data in the response. Repeat for multiple relationships. Use all to include everything.

Available options:
all,
visibility,
ruleset,
tracking_domain,
urls,
affiliate_tier,
account_manager,
sales_manager,
dmo,
offer_description,
forensiq,
twentyfour_metrics,
ip_quality_score,
optizmo,
unsubcentral

Body

application/json
search_terms
object[]

Text search filters. Each entry searches a specific field.

included_network_offer_ids
integer[]

Only return these specific offer IDs.

excluded_network_offer_ids
integer[]

Exclude these specific offer IDs from results.

included_offer_ids_overrides_other_filters
boolean

When true, the included offer IDs override all other filters.

filters
object

Structured filters to narrow results.

Response

200 - application/json
offers
object[]
paging
object