---
title: "Get Offer By ID"
method: GET
path: "/advertisers/offers/{offerId}"
tags: ["Advertiser Offers"]
---

# Get Offer By ID

`GET /advertisers/offers/{offerId}`

## Path parameters

- `offerId` integer, required

## Query parameters

- `relationship` 'category' | 'creatives' | 'reporting' | 'thumbnail_asset' | 'revenues' | 'ruleset' | 'remaining_caps' | 'meta'

## Response `200`

- AdvertiserOffer
  - `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` 'active' | 'paused' | 'pending' | 'deleted' — Current status of the offer.
  - `currency_id` string — Currency used for this offer (e.g. "USD").
  - `html_description` string — HTML description of the offer.
  - `visibility` 'public' | 'require_approval' | 'private' — Offer visibility setting.
  - `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.
  - `time_saved` integer — Unix timestamp of the last update to the offer.
  - `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.
    - `category` object — Offer category information.
      - `network_category_id` integer — Unique category ID.
      - `network_id` integer — Network ID that owns this category.
      - `name` string — Category name.
      - `status` string — Category status.
      - `time_created` integer — Unix timestamp when the category was created.
      - `time_saved` integer — Unix timestamp of the last update to the category.
    - `creatives` object — Offer creatives (banners, links, etc.).
      - `total` integer — Total number of creatives.
      - `entries` object[] — Array of creative objects.
        - `network_offer_creative_id` integer — Unique creative ID.
        - `network_id` integer — Network ID.
        - `network_offer_id` integer — Offer ID this creative belongs to.
        - `name` string — Creative name.
        - `creative_type` string — Type of creative (e.g. image, html, email).
        - `creative_status` string — Status of the creative.
        - `resource_url` string — URL of the creative resource (for image/file creatives).
        - `html_code` string — HTML code (for HTML creatives).
        - `width` integer — Creative width in pixels.
        - `height` integer — Creative height in pixels.
        - `is_private` boolean — Whether the creative is private.
        - `is_apply_specific_affiliates` boolean — Whether the creative is restricted to specific affiliates.
        - `additional_offer_ids` string — Comma-separated list of additional offer IDs this creative applies to.
        - `email_from` string — Email "from" address for email creatives.
        - `email_from_lines` string — Email "from" address lines for email creatives.
        - `email_subject` string — Email subject line for email creatives.
        - `email_subject_lines` string — Email subject lines for email creatives.
        - `time_created` integer — Unix timestamp when the creative was created.
        - `time_saved` integer — Unix timestamp of the last update to the creative.
    - `reporting` object — Aggregated performance reporting data for the offer.
      - `total_click` integer — Total number of clicks.
      - `unique_click` integer — Number of unique clicks.
      - `invalid_click` integer — Number of invalid/flagged clicks.
      - `cv` integer — Total conversions.
      - `cvr` number, float — Conversion rate.
      - `evr` number, float — Event rate.
      - `event` integer — Total events.
      - `ctr` number, float — Click-through rate.
      - `cost` number, float — Total cost.
      - `cpc` number, float — Cost per click.
      - `cpm` number, float — Cost per mille (thousand impressions).
      - `imp` integer — Total impressions.
      - `gross_sales` number, float — Total gross sales amount.
    - `revenues` object — Revenue configuration entries for the offer.
      - `total` integer — Total number of revenue entries.
      - `entries` object[] — Array of revenue entry objects.
        - `revenue_type` string — Type of revenue (e.g. cpa_flat, cpa_percentage, cpc).
        - `entry_name` string — Name of the revenue entry.
        - `revenue_amount` number, float — Fixed revenue amount (for flat revenue types).
        - `revenue_percentage` number, float — Revenue percentage (for percentage-based revenue types).
    - `ruleset` object — Targeting and rule configuration including geo, device, browser, and day-parting rules.
    - `remaining_caps` object — Remaining cap values for the offer across all cap types and time periods.
      - `remaining_daily_conversion_cap` integer — Remaining daily conversion cap.
      - `remaining_weekly_conversion_cap` integer — Remaining weekly conversion cap.
      - `remaining_monthly_conversion_cap` integer — Remaining monthly conversion cap.
      - `remaining_global_conversion_cap` integer — Remaining global conversion cap.
      - `remaining_daily_revenue_cap` integer — Remaining daily revenue cap.
      - `remaining_weekly_revenue_cap` integer — Remaining weekly revenue cap.
      - `remaining_monthly_revenue_cap` integer — Remaining monthly revenue cap.
      - `remaining_global_revenue_cap` integer — Remaining global revenue cap.
      - `remaining_daily_click_cap` integer — Remaining daily click cap.
      - `remaining_weekly_click_cap` integer — Remaining weekly click cap.
      - `remaining_monthly_click_cap` integer — Remaining monthly click cap.
      - `remaining_global_click_cap` integer — Remaining global click cap.
      - `remaining_daily_payout_cap` integer — Remaining daily payout cap.
      - `remaining_weekly_payout_cap` integer — Remaining weekly payout cap.
      - `remaining_monthly_payout_cap` integer — Remaining monthly payout cap.
      - `remaining_global_payout_cap` integer — Remaining global payout cap.
    - `meta` object — App store metadata including platform, bundle ID, ratings, and developer info.
    - `urls` object — Offer destination URLs.
      - `total` integer — Total number of URLs.
      - `entries` object[] — Array of URL entry objects.
    - `email` object — Email configuration for the offer.
      - `network_id` integer — Network ID.
      - `network_offer_id` integer — Offer ID.
      - `is_enabled` boolean — Whether email is enabled for this offer.
      - `from_lines` string — Approved from lines for email sends.
      - `subject_lines` string — Approved subject lines for email sends.

## Other responses

- `404` — Offer not found or not visible to the advertiser.

---

[API](https://skmtc.net/everflow/apis/everflow-network-api-tracking-domains.md) · [All operations](https://skmtc.net/everflow/apis/everflow-network-api-tracking-domains/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/everflow/everflow-network-api-tracking-domains/revisions/39242cee0e32/schema)
