Get Offer

GET /advertisers/offers/{offerId}

Get Offer By ID

cURL

curl --request GET \
  --url https://api.eflow.team/v1/advertisers/offers/{offerId} \
  --header 'X-Eflow-Api-Key: <api-key>'

200

{
  "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",
  "caps_timezone_id": 123,
  "date_live_until": "<string>",
  "is_using_explicit_terms_and_conditions": true,
  "terms_and_conditions": "<string>",
  "is_caps_enabled": true,
  "is_using_suppression_list": true,
  "suppression_list_id": 123,
  "network_tracking_domain_id": 123,
  "daily_conversion_cap": 123,
  "weekly_conversion_cap": 123,
  "monthly_conversion_cap": 123,
  "global_conversion_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": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "category": {
      "network_category_id": 123,
      "network_id": 123,
      "name": "<string>",
      "status": "<string>",
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "creatives": {
      "total": 123,
      "entries": [
        {
          "network_offer_creative_id": 123,
          "network_id": 123,
          "network_offer_id": 123,
          "name": "<string>",
          "creative_type": "<string>",
          "creative_status": "<string>",
          "resource_url": "<string>",
          "html_code": "<string>",
          "width": 123,
          "height": 123,
          "is_private": true,
          "is_apply_specific_affiliates": true,
          "additional_offer_ids": "<string>",
          "email_from": "<string>",
          "email_from_lines": "<string>",
          "email_subject": "<string>",
          "email_subject_lines": "<string>",
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ]
    },
    "reporting": {
      "total_click": 123,
      "unique_click": 123,
      "invalid_click": 123,
      "cv": 123,
      "cvr": 123,
      "evr": 123,
      "event": 123,
      "ctr": 123,
      "cost": 123,
      "cpc": 123,
      "cpm": 123,
      "imp": 123,
      "gross_sales": 123
    },
    "revenues": {
      "total": 123,
      "entries": [
        {
          "revenue_type": "<string>",
          "entry_name": "<string>",
          "revenue_amount": 123,
          "revenue_percentage": 123
        }
      ]
    },
    "ruleset": {},
    "remaining_caps": {
      "remaining_daily_conversion_cap": 123,
      "remaining_weekly_conversion_cap": 123,
      "remaining_monthly_conversion_cap": 123,
      "remaining_global_conversion_cap": 123,
      "remaining_daily_revenue_cap": 123,
      "remaining_weekly_revenue_cap": 123,
      "remaining_monthly_revenue_cap": 123,
      "remaining_global_revenue_cap": 123,
      "remaining_daily_click_cap": 123,
      "remaining_weekly_click_cap": 123,
      "remaining_monthly_click_cap": 123,
      "remaining_global_click_cap": 123,
      "remaining_daily_payout_cap": 123,
      "remaining_weekly_payout_cap": 123,
      "remaining_monthly_payout_cap": 123,
      "remaining_global_payout_cap": 123
    },
    "meta": {},
    "urls": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "email": {
      "network_id": 123,
      "network_offer_id": 123,
      "is_enabled": true,
      "from_lines": "<string>",
      "subject_lines": "<string>"
    }
  }
}

Retrieve a single offer by its ID. Returns the full offer object including caps, URLs, and visibility settings. Returns 404 if the offer does not exist or is not visible to the authenticated advertiser.

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

200

application/json

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

caps_timezone_id · integer

Timezone ID used for cap calculations.

date_live_until · string

Expiration date for the offer (empty string if no expiration).

is_using_explicit_terms_and_conditions · boolean

Whether the offer has explicit terms and conditions.

terms_and_conditions · string

The offer's terms and conditions text.

is_caps_enabled · boolean

Whether caps are enabled for this offer.

is_using_suppression_list · boolean

Whether the offer uses a suppression list.

suppression_list_id · integer

ID of the suppression list used (0 if none).

network_tracking_domain_id · integer

ID of the tracking domain used 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_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.

Example:

1734455015

time_saved · integer

Unix timestamp of the last update to the offer.

Example:

1734455015

relationship · object

Related data objects. This object is always present in the response. Use the relationship query parameter to populate specific sub-objects with data.

Show child attributes