Skip to main content
GET
Get Offer by ID
Retrieve a single offer by its ID with full configuration details. Use the relationship query parameter to include related data such as advertiser, visibility, payout_revenue, urls, ruleset, targeting, and more.

Authorizations

X-Eflow-Api-Key
string
header
required

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

Path Parameters

offerId
integer
required

The unique offer ID.

Query Parameters

relationship
enum<string>

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

Available options:
all,
advertiser,
application_questionnaire,
offer_group,
visibility,
payout_revenue,
custom_cap_settings,
custom_scrub_rate_settings,
custom_payout_revenue_settings,
custom_creative_settings,
redirects,
traffic_filters,
targeting,
files,
audits,
source_name,
urls,
active_urls,
integrations,
campaigns,
reporting,
advertiser_global_events,
offer_email,
offer_email_optout

Response

network_offer_id
integer

Unique offer ID.

network_id
integer
network_advertiser_id
integer

Advertiser that owns this offer.

network_offer_group_id
integer

Offer group ID.

name
string

Offer name.

offer_status
enum<string>
Available options:
active,
paused,
pending,
deleted
thumbnail_url
string
visibility
enum<string>
Available options:
public,
require_approval,
private
currency_id
string
destination_url
string

Destination URL for the offer.

server_side_url
string

Server-side postback URL.

preview_url
string
html_description
string

HTML description of the offer.

internal_notes
string

Internal notes (not visible to affiliates).

network_category_id
integer
project_id
string
date_live_until
string

Offer expiration date (YYYY-MM-DD).

conversion_method
enum<string>
Available options:
server_postback,
http_image_pixel,
https_image_pixel,
http_iframe_pixel,
https_iframe_pixel,
javascript,
cookie_based,
html_pixel_cookie_based
redirect_mode
enum<string>
Available options:
standard,
single_meta_refresh,
double_meta_refresh,
seo_friendly
session_definition
enum<string>
Available options:
cookie,
ip,
ip_user_agent,
google_ad_id,
idfa
session_duration
integer

Session duration in hours.

attribution_method
enum<string>
Available options:
first_touch,
last_touch
is_caps_enabled
boolean
daily_conversion_cap
integer
weekly_conversion_cap
integer
monthly_conversion_cap
integer
global_conversion_cap
integer
daily_payout_cap
integer
weekly_payout_cap
integer
monthly_payout_cap
integer
global_payout_cap
integer
daily_revenue_cap
integer
weekly_revenue_cap
integer
monthly_revenue_cap
integer
global_revenue_cap
integer
daily_click_cap
integer
weekly_click_cap
integer
monthly_click_cap
integer
global_click_cap
integer
is_use_scrub_rate
boolean
scrub_rate_percentage
integer
is_duplicate_filter_enabled
boolean
is_block_already_converted
boolean
is_session_tracking_enabled
boolean
session_tracking_lifespan_hour
integer
session_tracking_minimum_lifespan_second
integer
session_tracking_start_on
enum<string>
Available options:
null_value,
impression,
click
is_whitelist_check_enabled
boolean
is_using_suppression_list
boolean
suppression_list_id
integer
network_tracking_domain_id
integer
caps_timezone_id
integer
app_identifier
string
is_description_plain_text
boolean
terms_and_conditions
string
is_force_terms_and_conditions
boolean
is_using_explicit_terms_and_conditions
boolean
redirect_routing_method
enum<string>
Available options:
unknown,
internal,
null_value
redirect_internal_routing_type
enum<string>
Available options:
unknown,
priority,
weight,
null_value,
priority_global,
weight_global
scrub_rate_status
enum<string>
Available options:
rejected,
pending
duplicate_filter_targeting_action
enum<string>
Available options:
unknown,
block,
fail_traffic
already_converted_action
enum<string>
Available options:
unknown,
block,
fail_traffic
is_must_approve_conversion
boolean
is_allow_duplicate_conversion
boolean
is_use_direct_linking
boolean
is_seo_friendly
boolean
is_fail_traffic_enabled
boolean
is_view_through_enabled
boolean
is_view_through_session_tracking_enabled
boolean
view_through_destination_url
string
view_through_session_tracking_lifespan_minute
integer
view_through_session_tracking_minimal_lifespan_second
integer
is_email_attribution_enabled
boolean
is_email_attribution_window_enabled
boolean
email_attribution_method
enum<string>
Available options:
first_affiliate_attribution,
last_affiliate_attribution
email_attribution_window_minute
integer
email_attribution_window_type
enum<string>
Available options:
static,
dynamic
is_soft_cap
boolean
time_created
integer
Example:

1734455015

time_saved
integer
Example:

1734455015

relationship
object

Related data returned with the offer.