Skip to main content
GET
/
partners
/
offers
/
{networkId}
/
{offerId}
Get Offer By ID
curl --request GET \
  --url https://api.eflow.team/v1/partners/offers/{networkId}/{offerId} \
  --header 'X-Eflow-Api-Key: <api-key>'
{
  "network_offer_id": 123,
  "network_id": 123,
  "name": "<string>",
  "offer_status": "active",
  "thumbnail_url": "<string>",
  "network_category_id": 123,
  "destination_url": "<string>",
  "preview_url": "<string>",
  "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>",
  "impression_tracking_url": "<string>",
  "redirect_tracking_url": "<string>",
  "time_created": 123,
  "time_saved": 123,
  "relationship": {
    "category": {},
    "creatives": [
      {}
    ],
    "reporting": {},
    "payouts": [
      {}
    ],
    "ruleset": {},
    "urls": [
      {}
    ],
    "channels": [
      {}
    ],
    "creative_bundle": {},
    "remaining_caps": {},
    "custom_payout_settings": {}
  }
}

Authorizations

X-Eflow-Api-Key
string
header
required

The marketplace partner's API key. Uses the X-Eflow-Api-Key header. The key belongs to the marketplace partner user.

Path Parameters

networkId
integer
required

The network ID that owns the offer.

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,
payouts,
ruleset,
urls,
channels,
creative_bundle,
remaining_caps,
custom_payout_settings

Response

OK

network_offer_id
integer

Unique offer ID.

network_id
integer

Network ID that owns this offer.

name
string

Offer name.

offer_status
enum<string>

Current status of the offer.

Available options:
active,
paused,
pending,
deleted
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.

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 click tracking URL used to route traffic.

impression_tracking_url
string

URL for tracking impressions.

redirect_tracking_url
string

URL for redirect-based tracking.

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).