Offers & Affiliates - Everflow API

Four tools for looking up the offers and partners on your network. Use the get_ tools when you already have an ID, and the list_ tools to find one.

Tool	Requires	Use when
get_offer	Offer → Manage	You have an offer ID and need its full configuration
list_offers	Offer → Manage	You need to find offers, or resolve a name to an ID
get_affiliate	Partner → Manage	You have an affiliate ID and need its full profile
list_affiliates	Partner → Manage	You need to find partners, or resolve a name to an ID

get_offer

Retrieves full details for a single offer. Use include to add caps, targeting rules, payout structure, and affiliate access. Requires: Offer → Manage (Read Only) Ask for it: “What are the caps and payout on offer 1234?” Parameters

Parameter	Type	Required	Default	Description
`offer_id`	number	Yes	—	Numeric offer ID
`include`	string	No	—	Comma-separated: `caps`, `targeting`, `payout`, `affiliate`, `affiliates`, `tracking_url`. Max 256 chars
`affiliate_id`	number	No	—	Required when `include` contains `affiliate` or `tracking_url`
`affiliate_ids`	string	No	—	For `include=affiliates` only — comma-separated affiliate IDs to filter. Max 1,024 chars
`cursor`	string	No	—	Pagination cursor for `include=affiliates`. Max 1,024 chars

Example

get_offer(offer_id=1234, include="caps,payout,targeting")
→ the offer's configuration plus its cap consumption, payout tiers, and geo/device rules

Returns

Field	Type	Description
`offer_id`	number	Numeric offer ID
`name`	string	Offer name
`status`	string	Offer status
`visibility`	string	Offer visibility setting (`public`, `require_approval`, `private`)
`currency`	string	Offer currency
`advertiser_id`	number	Advertiser ID
`advertiser_name`	string	Advertiser name
`destination_url`	string	Offer destination URL (contains the `{transaction_id}` macro)
`conversion_method`	string	How conversions are tracked (e.g. `server_postback`)
`session_duration`	number	Attribution session/cookie window (hours)
`attribution_method`	string	Attribution model (e.g. `last_touch`)
`payout_type`	string	Payout model: `CPA` (flat per conversion), `CPS` (% of sale), `CPA+CPS` (mixed), `CPC` (per click), `CPM` (per 1,000 impressions), `PRV` (% of revenue)
`channels`	array	Approved traffic methods for this offer
`date_live_until`	string	Expiration date — present only when set
`category_id`	number	Category ID (if set)
`category_name`	string	Category name (if set)
`labels`	array	Labels assigned to this offer
`offer_group_id`	number	Offer group ID — present only when the offer is in a group
`preview_url`	string	Offer preview URL — present only when set
`description`	string	Offer’s marketing description — present only when set. May be plain text or raw HTML (see `is_description_plain_text`)
`is_description_plain_text`	boolean	Present only alongside `description`. `true` = plain text; `false` = raw HTML (tags, iframes, entities)

Includes

Include	Adds	Needs
`caps`	Click, conversion, payout, and revenue budget limits, with current consumption	—
`targeting`	Geo restrictions, device rules, day-parting, and eligibility conditions	—
`payout`	Payout tiers, events, and rules	—
`affiliate`	This affiliate’s `approval_status` and visibility for the offer	`affiliate_id`
`tracking_url`	The affiliate’s unique tracking link	`affiliate_id`
`affiliates`	Affiliates with an explicit relationship to this offer — filtered by the offer’s own visibility (see the gotcha below). Returns `visibility`, `status_filter`, `total`, a paginated `affiliates` array, `has_more` and `next_cursor`	—

Gotchas

include=affiliates returns different sets depending on the offer’s visibility. On a public offer it returns only blocked affiliates (everyone else is implicitly approved). On a require_approval or private offer it returns only approved affiliates. The status_filter field in the response tells you which rule applied — read it before interpreting the list.
Treat the tracking_url include — not approval_status — as the authority on whether a partner can actually run the offer.
description may contain raw HTML. Render or strip it before showing it to a user; don’t quote it verbatim.
To inspect the nested field structure each include returns, call get_entity_schema(type="offer").

list_offers

Lists offers with optional filters, as a paginated compact view. The fastest way to resolve an offer name to an ID. Requires: Offer → Manage (Read Only) Ask for it: “List every active offer for advertiser Acme.” Parameters

Parameter	Type	Required	Default	Description
`search`	string	No	—	Search by offer name. Max 256 chars
`status`	string	No	—	`active`, `paused`, `pending`, `deleted`. Max 256 chars
`advertiser_id`	string	No	—	Filter by advertiser ID (numeric string)
`advertiser`	string	No	—	Search by advertiser name. Max 256 chars
`category`	string	No	—	Filter by category name (substring match). Max 256 chars
`label`	string	No	—	Filter by label name (substring match, case-insensitive). Max 256 chars
`destination_url`	string	No	—	Only offers whose destination (landing) URL contains this substring, case-insensitive (e.g. `appsflyer`). Max 256 chars
`created_after`	string	No	—	Only offers created on or after this date, inclusive (`YYYY-MM-DD`, network timezone)
`created_before`	string	No	—	Only offers created on or before this date, inclusive (`YYYY-MM-DD`, network timezone)
`page_size`	number	No	25	Rows per page (1–100)
`cursor`	string	No	—	Pagination cursor from a prior response. Max 1,024 chars

Example

list_offers(search="Acme", status="active", page_size=10)
→ up to 10 active offers matching "Acme", with next_cursor when more exist

Returns Envelope:

Field	Type	Description
`has_more`	boolean	`true` if additional pages exist
`next_cursor`	string	Pass as `cursor` to retrieve the next page
`rows_returned`	number	Number of records in this page
`total_matching`	number	Total records matching the query
`page_size`	number	Rows-per-page applied to this response
`offset`	number	Zero-based offset of the first returned row

Per row:

Field	Type	Description
`offer_id`	number	Numeric offer ID
`name`	string	Offer name
`status`	string	Offer status
`visibility`	string	Visibility setting
`advertiser_id`	number	Advertiser ID
`advertiser_name`	string	Advertiser name
`currency`	string	Offer currency
`encoded_value`	string	Encoded offer ID
`category_id`	number	Category ID (if set)
`category_name`	string	Category name (if set)
`date_live_until`	string	Expiry date (if set)
`labels`	array	Labels assigned to this offer

Gotchas

created_before is inclusive of that day. For a strictly-before bound (“created before Jul 10”), pass the previous day (2026-07-09).
When you filter on destination_url, the matched URL is echoed on each row. Pair it with status=active to see only live offers.
List tools return total_matching. run_performance_report returns total_rows instead — they are not the same field.
created_after / created_before are validated before the call: anything that isn’t YYYY-MM-DD returns INVALID_ARGUMENT naming the parameter and the value you sent.

get_affiliate

Retrieves full details for a single affiliate. Use include to add activity metrics, users, offer access, and billing terms. Requires: Partner → Manage (Read Only) Ask for it: “Give me a profile of partner 3296, including how active they’ve been.” Parameters

Parameter	Type	Required	Default	Description
`affiliate_id`	number	Yes	—	Numeric affiliate ID
`include`	string	No	—	Comma-separated: `activity`, `users`, `offers`, `billing`. Max 256 chars
`timezone`	string	No	Network timezone	IANA timezone for activity timestamps. Max 64 chars
`offer_ids`	string	No	—	For `include=offers` only — comma-separated offer IDs to check visibility for. Max 1,024 chars
`can_run`	string	No	—	For `include=offers` only — filter by runnable status: `yes` or `no`. Max 8 chars
`cursor`	string	No	—	For `include=offers` only — pagination cursor from a prior response. Max 1,024 chars

Example

get_affiliate(affiliate_id=3296, include="activity,offers", can_run="yes")
→ the partner's profile, their 7-day performance, and every offer they can currently run

Returns

Field	Type	Description
`affiliate_id`	number	Numeric affiliate ID
`name`	string	Affiliate name
`status`	string	`active`, `inactive`, `suspended`, or `pending` (a signup awaiting network approval)
`currency`	string	Default currency
`manager_id`	number	Account manager employee ID
`manager_name`	string	Account manager name
`tier_id`	number	Tier ID (if assigned)
`tier_name`	string	Tier name (if assigned)
`labels`	array	Labels assigned to this affiliate
`internal_notes`	string	Internal notes — present only when set

Includes

Include	Adds
`activity`	Portal login frequency, API usage, 7-day click/conversion performance, and last active date
`users`	Contact details (names, titles, emails) for the affiliate’s team
`offers`	Paginated list of offers the affiliate can run, with visibility type and approval status
`billing`	Payment terms: `billing_frequency`, `payment_method`, `invoice_type`, `is_payable`, `is_automated_payment_enabled`, `vat_percentage`

Gotchas

include=billing returns scalar settings only — payment-method custom settings are not flattened into it.
Coupon codes are not an include. Use list_entities(type="coupon_code", filters={"affiliate_id": 3296}).

list_affiliates

Lists affiliates with optional filters, as a paginated compact view. Also the way to find pending partner applications. Requires: Partner → Manage (Read Only) Ask for it: “Which partner applications are still waiting for approval?” Parameters

Parameter	Type	Required	Default	Description
`search`	string	No	—	Search by affiliate name or company. Max 256 chars
`status`	string	No	—	`active`, `inactive`, `suspended`, `pending`. Max 256 chars
`manager_id`	number	No	—	Filter by account manager employee ID
`label`	string	No	—	Filter by label name (substring match). Max 256 chars
`tier`	string	No	—	Filter by tier name (substring match). Max 256 chars
`referred_by`	number	No	—	Only affiliates referred by this affiliate ID (their “Referred By”)
`created_after`	string	No	—	Only affiliates created on or after this date, inclusive (`YYYY-MM-DD`, network timezone)
`created_before`	string	No	—	Only affiliates created on or before this date, inclusive (`YYYY-MM-DD`, network timezone)
`page_size`	number	No	25	Rows per page (1–100)
`cursor`	string	No	—	Pagination cursor from a prior response. Max 1,024 chars

Example

list_affiliates(status="pending")
→ every new-partner signup awaiting network approval

Returns Envelope:

Field	Type	Description
`has_more`	boolean	`true` if additional pages exist
`next_cursor`	string	Pass as `cursor` to retrieve the next page
`rows_returned`	number	Number of records in this page
`total_matching`	number	Total records matching the query
`page_size`	number	Rows-per-page applied to this response

Per row:

Field	Type	Description
`affiliate_id`	number	Numeric affiliate ID
`name`	string	Affiliate name
`status`	string	Account status
`manager_id`	number	Account manager employee ID
`default_currency_id`	string	Default currency
`tier_id`	number	Tier ID (if assigned)
`tier_name`	string	Tier name (if assigned)
`time_created`	string	Signup timestamp in the network timezone (matches the `created_after`/`created_before` day boundaries)
`referrer_id`	number	The affiliate who referred this one (present only when referred)
`referrer_name`	string	Name of the referring affiliate (present only when referred)
`labels`	array	Labels assigned to this affiliate

Gotchas

status="pending" means a partner application — a new signup awaiting approval, not a paused account.
created_before is inclusive of that day, same as list_offers.

​get_offer

​list_offers

​get_affiliate

​list_affiliates

get_offer

list_offers

get_affiliate

list_affiliates