Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Marketplace Offers

Get Offer By ID

get/partners/offers/{networkId}/{offerId}

Path parameters

networkIdinteger required

The network ID that owns the offer.

offerIdinteger required

The unique offer ID.

Query parameters

relationship'category' | 'creatives' | 'reporting' | 'payouts' | 'ruleset' | 'urls' | 'channels' | 'creative_bundle' | 'remaining_caps' | 'custom_payout_settings'

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

Response

network_offer_idinteger

Unique offer ID.

network_idinteger

Network ID that owns this offer.

namestring

Offer name.

offer_status'active' | 'paused' | 'pending' | 'deleted'

Current status of the offer.

thumbnail_urlstring

Offer thumbnail image URL.

network_category_idinteger

Category ID for the offer.

preview_urlstring

Preview URL for the offer landing page.

currency_idstring

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

html_descriptionstring

HTML description of the offer.

visibility'public' | 'require_approval' | 'private'

Offer visibility setting.

is_caps_enabledboolean

Whether caps are enabled for this offer.

daily_conversion_capinteger

Maximum conversions allowed per day. 0 means unlimited.

weekly_conversion_capinteger

Maximum conversions allowed per week. 0 means unlimited.

monthly_conversion_capinteger

Maximum conversions allowed per month. 0 means unlimited.

global_conversion_capinteger

Maximum total conversions allowed. 0 means unlimited.

daily_payout_capinteger

Maximum payout amount per day. 0 means unlimited.

weekly_payout_capinteger

Maximum payout amount per week. 0 means unlimited.

monthly_payout_capinteger

Maximum payout amount per month. 0 means unlimited.

global_payout_capinteger

Maximum total payout amount. 0 means unlimited.

daily_click_capinteger

Maximum clicks allowed per day. 0 means unlimited.

weekly_click_capinteger

Maximum clicks allowed per week. 0 means unlimited.

monthly_click_capinteger

Maximum clicks allowed per month. 0 means unlimited.

global_click_capinteger

Maximum total clicks allowed. 0 means unlimited.

tracking_urlstring

The click tracking URL used to route traffic.

impression_tracking_urlstring

URL for tracking impressions.

redirect_tracking_urlstring

URL for redirect-based tracking.

time_createdinteger

Unix timestamp of when the offer was created.

time_savedinteger

Unix timestamp of the last update to the offer.

app_identifierstring

App identifier.

caps_timezone_idinteger

Timezone ID for cap calculations.

date_live_untilstring

Offer expiration date (empty string if none).

is_description_plain_textboolean

Whether description is plain text.

is_force_terms_and_conditionsboolean

Whether terms acceptance is forced.

is_use_direct_linkingboolean

Whether direct linking is allowed.

is_using_explicit_terms_and_conditionsboolean

Whether offer has explicit terms and conditions.

is_using_suppression_listboolean

Whether offer uses suppression list.

network_tracking_domain_idinteger

Tracking domain ID.

suppression_list_idinteger

Suppression list ID (0 if none).

terms_and_conditionsstring

Terms and conditions text.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "category": {
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "channels": {
      "entries": [
        {
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ]
    },
    "creatives": {
      "entries": [
        {
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ]
    },
    "meta": {
      "time_app_data_saved": 1734455015,
      "time_created": 1734455015,
      "time_saved": 1734455015
    },
    "ruleset": {
      "time_created": 1734455015,
      "time_saved": 1734455015
    }
  }
}