Skip to main content
GET
/
advertisers
/
offers
/
{offerId}
Get Offer By ID
curl --request GET \
  --url https://api.eflow.team/v1/advertisers/offers/{offerId} \
  --header 'X-Eflow-Api-Key: <api-key>'
{
  "network_offer_id": 123,
  "network_id": 123,
  "name": "<string>",
  "thumbnail_url": "<string>",
  "network_category_id": 123,
  "destination_url": "<string>",
  "preview_url": "<string>",
  "offer_status": "active",
  "currency_id": "<string>",
  "html_description": "<string>",
  "visibility": "public",
  "is_caps_enabled": true,
  "daily_conversion_cap": 123,
  "weekly_conversion_cap": 123,
  "monthly_conversion_cap": 123,
  "global_conversion_cap": 123,
  "daily_payout_cap": 123,
  "weekly_payout_cap": 123,
  "monthly_payout_cap": 123,
  "global_payout_cap": 123,
  "daily_revenue_cap": 123,
  "weekly_revenue_cap": 123,
  "monthly_revenue_cap": 123,
  "global_revenue_cap": 123,
  "daily_click_cap": 123,
  "weekly_click_cap": 123,
  "monthly_click_cap": 123,
  "global_click_cap": 123,
  "tracking_url": "<string>",
  "time_created": 123,
  "time_saved": 123,
  "relationship": {}
}

Authorizations

​
X-Eflow-Api-Key
string
header
required

The advertiser's API key generated from the Advertiser Portal. Uses the same X-Eflow-Api-Key header as other Everflow APIs, but the key belongs to the advertiser user rather than the network admin.

Path Parameters

​
offerId
integer
required

The unique offer ID.

Query Parameters

​
relationship
enum<string>

Include related data in the response. Repeat for multiple relationships.

Available options:
category,
creatives,
reporting,
thumbnail_asset,
revenues,
ruleset,
remaining_caps,
meta

Response

OK

​
network_offer_id
integer

Unique offer ID.

​
network_id
integer

Network ID that owns this offer.

​
name
string

Offer name.

​
thumbnail_url
string

Offer thumbnail image URL.

​
network_category_id
integer

Category ID for the offer.

​
destination_url
string

The destination URL where traffic is sent.

​
preview_url
string

Preview URL for the offer landing page.

​
offer_status
enum<string>

Current status of the offer.

Available options:
active,
paused,
pending,
deleted
​
currency_id
string

Currency used for this offer (e.g. "USD").

​
html_description
string

HTML description of the offer.

​
visibility
enum<string>

Offer visibility setting.

Available options:
public,
require_approval,
private
​
is_caps_enabled
boolean

Whether caps are enabled for this offer.

​
daily_conversion_cap
integer

Maximum conversions allowed per day. 0 means unlimited.

​
weekly_conversion_cap
integer

Maximum conversions allowed per week. 0 means unlimited.

​
monthly_conversion_cap
integer

Maximum conversions allowed per month. 0 means unlimited.

​
global_conversion_cap
integer

Maximum total conversions allowed. 0 means unlimited.

​
daily_payout_cap
integer

Maximum payout amount per day. 0 means unlimited.

​
weekly_payout_cap
integer

Maximum payout amount per week. 0 means unlimited.

​
monthly_payout_cap
integer

Maximum payout amount per month. 0 means unlimited.

​
global_payout_cap
integer

Maximum total payout amount. 0 means unlimited.

​
daily_revenue_cap
integer

Maximum revenue amount per day. 0 means unlimited.

​
weekly_revenue_cap
integer

Maximum revenue amount per week. 0 means unlimited.

​
monthly_revenue_cap
integer

Maximum revenue amount per month. 0 means unlimited.

​
global_revenue_cap
integer

Maximum total revenue amount. 0 means unlimited.

​
daily_click_cap
integer

Maximum clicks allowed per day. 0 means unlimited.

​
weekly_click_cap
integer

Maximum clicks allowed per week. 0 means unlimited.

​
monthly_click_cap
integer

Maximum clicks allowed per month. 0 means unlimited.

​
global_click_cap
integer

Maximum total clicks allowed. 0 means unlimited.

​
tracking_url
string

The tracking URL used to route traffic to this offer.

​
time_created
integer

Unix timestamp of when the offer was created.

​
time_saved
integer

Unix timestamp of the last update to the offer.

​
relationship
object

Related data (only present when requested via the relationship query parameter).