Skip to main content
GET
/
affiliates
/
offers
/
{offerId}
Find Offer By ID
curl --request GET \
  --url https://api.eflow.team/v1/affiliates/offers/{offerId} \
  --header 'X-Eflow-Api-Key: <api-key>'
{
  "network_offer_id": 123,
  "network_id": 123,
  "name": "<string>",
  "offer_status": "<string>",
  "currency_id": "<string>",
  "visibility": "<string>",
  "html_description": "<string>",
  "is_description_plain_text": true,
  "preview_url": "<string>",
  "tracking_url": "<string>",
  "redirect_tracking_url": "<string>",
  "impression_tracking_url": "<string>",
  "thumbnail_url": "<string>",
  "network_category_id": 123,
  "is_caps_enabled": true,
  "caps_timezone_id": 123,
  "daily_conversion_cap": 123,
  "weekly_conversion_cap": 123,
  "monthly_conversion_cap": 123,
  "global_conversion_cap": 123,
  "daily_click_cap": 123,
  "weekly_click_cap": 123,
  "monthly_click_cap": 123,
  "global_click_cap": 123,
  "daily_payout_cap": 123,
  "weekly_payout_cap": 123,
  "monthly_payout_cap": 123,
  "global_payout_cap": 123,
  "is_force_terms_and_conditions": true,
  "is_using_explicit_terms_and_conditions": true,
  "terms_and_conditions": "<string>",
  "is_use_direct_linking": true,
  "is_using_suppression_list": true,
  "suppression_list_id": 123,
  "network_tracking_domain_id": 123,
  "app_identifier": "<string>",
  "date_live_until": "<string>",
  "time_created": "<string>",
  "time_saved": "<string>",
  "relationship": {
    "offer_affiliate_status": "<string>",
    "blocked_variables_count": 123,
    "category": {
      "network_category_id": 123,
      "network_id": 123,
      "name": "<string>",
      "status": "<string>",
      "time_created": 123,
      "time_saved": 123
    },
    "channels": {
      "entries": [
        {}
      ],
      "total": 123
    },
    "creative_bundle": {
      "url": "<string>"
    },
    "creatives": {
      "entries": [
        {}
      ],
      "total": 123
    },
    "custom_payout_settings": {
      "entries": [
        {}
      ],
      "total": 123
    },
    "email": {},
    "email_optout": {},
    "integrations": {
      "ezepo": {},
      "invoca": {},
      "optizmo": {},
      "retreaver": {},
      "ringa": {},
      "unsubcentral": {}
    },
    "meta": {},
    "payouts": {
      "entries": [
        {}
      ],
      "total": 123
    },
    "remaining_caps": {
      "remaining_daily_click_cap": 123,
      "remaining_daily_conversion_cap": 123,
      "remaining_daily_payout_cap": 123
    },
    "reporting": {},
    "requirement_kpis": {
      "entries": [
        {}
      ],
      "total": 123
    },
    "requirement_tracking_parameters": {
      "entries": [
        {}
      ],
      "total": 123
    },
    "ruleset": {},
    "terms_conditions_acceptance": {},
    "thumbnail_asset": {},
    "urls": {
      "entries": [
        {}
      ],
      "total": 123
    }
  }
}
Returns full details for a single offer including integrations, meta information, and email configuration. The offer must be visible to the authenticated affiliate (public, approved, or requiring approval). Returns 404 if the offer does not exist or is not visible to the affiliate. The response has the same top-level offer fields and relationship structure as the offersrunnable endpoint, plus additional relationship keys for email, email_optout, and integrations.

Authorizations

X-Eflow-Api-Key
string
header
required

The affiliate's API key generated from the Affiliate Portal. Uses the X-Eflow-Api-Key header.

Path Parameters

offerId
integer
required

The numeric ID of the offer.

Response

network_offer_id
integer

Unique identifier for the offer.

network_id
integer

Network ID.

name
string

Offer name.

offer_status
string

Current status of the offer.

currency_id
string

Currency code for the offer.

visibility
string

Visibility setting of the offer.

html_description
string

Offer description in HTML format.

is_description_plain_text
boolean

Whether the description is plain text or HTML.

preview_url
string

Preview URL for the offer landing page.

tracking_url
string

Base tracking URL.

redirect_tracking_url
string

Redirect tracking URL.

impression_tracking_url
string

Impression tracking URL.

thumbnail_url
string

URL of the offer thumbnail image.

network_category_id
integer

Category ID for the offer.

is_caps_enabled
boolean

Whether caps are enabled for this offer.

caps_timezone_id
integer

Timezone ID used for cap calculations.

daily_conversion_cap
integer

Daily conversion cap.

weekly_conversion_cap
integer

Weekly conversion cap.

monthly_conversion_cap
integer

Monthly conversion cap.

global_conversion_cap
integer

Global (lifetime) conversion cap.

daily_click_cap
integer

Daily click cap.

weekly_click_cap
integer

Weekly click cap.

monthly_click_cap
integer

Monthly click cap.

global_click_cap
integer

Global (lifetime) click cap.

daily_payout_cap
number

Daily payout cap.

weekly_payout_cap
number

Weekly payout cap.

monthly_payout_cap
number

Monthly payout cap.

global_payout_cap
number

Global (lifetime) payout cap.

is_force_terms_and_conditions
boolean

Whether terms and conditions acceptance is required.

is_using_explicit_terms_and_conditions
boolean

Whether the offer uses explicit terms and conditions.

terms_and_conditions
string

Terms and conditions text.

is_use_direct_linking
boolean

Whether direct linking is enabled.

is_using_suppression_list
boolean

Whether a suppression list is in use.

suppression_list_id
integer

Suppression list ID.

network_tracking_domain_id
integer

Tracking domain ID.

app_identifier
string

App store identifier for mobile offers.

date_live_until
string

Date until which the offer is live.

time_created
string

Timestamp when the offer was created.

time_saved
string

Timestamp when the offer was last saved.

relationship
object

Affiliate-specific relationship data. Contains the same keys as the offersrunnable relationship, plus email, email_optout, and integrations.