Skip to main content
POST
Find Custom Payout & Revenues (Advanced)
Retrieve a paginated list of custom payout/revenue settings. Supports search filters, sorting, and pagination to help you find and browse custom payout and revenue configurations programmatically.

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.

relationship
enum<string>

Include related data. Use offer for offer details, affiliates for full affiliate list, limited_affiliates for up to 5 affiliates, payout_revenue_event_name for the base event name, offer_urls for associated offer URLs, or all for everything. Repeat the parameter for multiple values.

Available options:
offer,
affiliates,
limited_affiliates,
payout_revenue_event_name,
offer_urls,
all
order_field
enum<string>

Field to order results by.

Available options:
id,
name,
relationship.offer.name,
time_created,
time_saved
order_direction
enum<string>

Sort direction.

Available options:
asc,
desc

Body

application/json
search_terms
object[]

Text search filters.

filters
object

Structured filters to narrow results.

Response

200 - application/json
custom_payout_revenue_settings
object[]
paging
object