> ## Documentation Index
> Fetch the complete documentation index at: https://developers.everflow.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Offer

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.


## OpenAPI

````yaml openapi/advertiser-offers.yaml get /advertisers/offers/{offerId}
openapi: 3.0.3
info:
  title: Everflow Advertiser API - Offers
  description: >
    Offer endpoints for the Everflow Advertiser API. These endpoints are
    accessed by advertiser users using their own API key and return data scoped
    to the authenticated advertiser's account only.
  version: 1.0.0
servers:
  - description: Production Server
    url: https://api.eflow.team/v1
security: []
tags:
  - name: Advertiser Offers
    description: >-
      Endpoints for listing and retrieving offers visible to the authenticated
      advertiser.
paths:
  /advertisers/offers/{offerId}:
    get:
      tags:
        - Advertiser Offers
      summary: Get Offer By ID
      parameters:
        - in: path
          name: offerId
          required: true
          schema:
            type: integer
          description: The unique offer ID.
        - in: query
          name: relationship
          schema:
            type: string
            enum:
              - category
              - creatives
              - reporting
              - thumbnail_asset
              - revenues
              - ruleset
              - remaining_caps
              - meta
          description: >-
            Include related data in the response. Repeat for multiple
            relationships.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvertiserOffer'
        '404':
          description: Offer not found or not visible to the advertiser.
      security:
        - API Key: []
components:
  schemas:
    AdvertiserOffer:
      type: object
      properties:
        network_offer_id:
          type: integer
          description: Unique offer ID.
        network_id:
          type: integer
          description: Network ID that owns this offer.
        name:
          type: string
          description: Offer name.
        thumbnail_url:
          type: string
          description: Offer thumbnail image URL.
        network_category_id:
          type: integer
          description: Category ID for the offer.
        destination_url:
          type: string
          description: The destination URL where traffic is sent.
        preview_url:
          type: string
          description: Preview URL for the offer landing page.
        offer_status:
          type: string
          enum:
            - active
            - paused
            - pending
            - deleted
          description: Current status of the offer.
        currency_id:
          type: string
          description: Currency used for this offer (e.g. "USD").
        html_description:
          type: string
          description: HTML description of the offer.
        visibility:
          type: string
          enum:
            - public
            - require_approval
            - private
          description: Offer visibility setting.
        caps_timezone_id:
          type: integer
          description: Timezone ID used for cap calculations.
        date_live_until:
          type: string
          description: Expiration date for the offer (empty string if no expiration).
        is_using_explicit_terms_and_conditions:
          type: boolean
          description: Whether the offer has explicit terms and conditions.
        terms_and_conditions:
          type: string
          description: The offer's terms and conditions text.
        is_caps_enabled:
          type: boolean
          description: Whether caps are enabled for this offer.
        is_using_suppression_list:
          type: boolean
          description: Whether the offer uses a suppression list.
        suppression_list_id:
          type: integer
          description: ID of the suppression list used (0 if none).
        network_tracking_domain_id:
          type: integer
          description: ID of the tracking domain used for this offer.
        daily_conversion_cap:
          type: integer
          description: Maximum conversions allowed per day. 0 means unlimited.
        weekly_conversion_cap:
          type: integer
          description: Maximum conversions allowed per week. 0 means unlimited.
        monthly_conversion_cap:
          type: integer
          description: Maximum conversions allowed per month. 0 means unlimited.
        global_conversion_cap:
          type: integer
          description: Maximum total conversions allowed. 0 means unlimited.
        daily_revenue_cap:
          type: integer
          description: Maximum revenue amount per day. 0 means unlimited.
        weekly_revenue_cap:
          type: integer
          description: Maximum revenue amount per week. 0 means unlimited.
        monthly_revenue_cap:
          type: integer
          description: Maximum revenue amount per month. 0 means unlimited.
        global_revenue_cap:
          type: integer
          description: Maximum total revenue amount. 0 means unlimited.
        daily_click_cap:
          type: integer
          description: Maximum clicks allowed per day. 0 means unlimited.
        weekly_click_cap:
          type: integer
          description: Maximum clicks allowed per week. 0 means unlimited.
        monthly_click_cap:
          type: integer
          description: Maximum clicks allowed per month. 0 means unlimited.
        global_click_cap:
          type: integer
          description: Maximum total clicks allowed. 0 means unlimited.
        tracking_url:
          type: string
          description: The tracking URL used to route traffic to this offer.
        time_created:
          type: integer
          example: 1734455015
          description: Unix timestamp of when the offer was created.
        time_saved:
          type: integer
          example: 1734455015
          description: Unix timestamp of the last update to the offer.
        relationship:
          type: object
          description: >
            Related data objects. This object is always present in the response.
            Use the `relationship` query parameter to populate specific
            sub-objects with data.
          properties:
            category:
              type: object
              description: Offer category information.
              properties:
                network_category_id:
                  type: integer
                  description: Unique category ID.
                network_id:
                  type: integer
                  description: Network ID that owns this category.
                name:
                  type: string
                  description: Category name.
                status:
                  type: string
                  description: Category status.
                time_created:
                  type: integer
                  example: 1734455015
                  description: Unix timestamp when the category was created.
                time_saved:
                  type: integer
                  example: 1734455015
                  description: Unix timestamp of the last update to the category.
            creatives:
              type: object
              description: Offer creatives (banners, links, etc.).
              properties:
                total:
                  type: integer
                  description: Total number of creatives.
                entries:
                  type: array
                  description: Array of creative objects.
                  items:
                    type: object
                    properties:
                      network_offer_creative_id:
                        type: integer
                        description: Unique creative ID.
                      network_id:
                        type: integer
                        description: Network ID.
                      network_offer_id:
                        type: integer
                        description: Offer ID this creative belongs to.
                      name:
                        type: string
                        description: Creative name.
                      creative_type:
                        type: string
                        description: Type of creative (e.g. image, html, email).
                      creative_status:
                        type: string
                        description: Status of the creative.
                      resource_url:
                        type: string
                        description: >-
                          URL of the creative resource (for image/file
                          creatives).
                      html_code:
                        type: string
                        description: HTML code (for HTML creatives).
                      width:
                        type: integer
                        description: Creative width in pixels.
                      height:
                        type: integer
                        description: Creative height in pixels.
                      is_private:
                        type: boolean
                        description: Whether the creative is private.
                      is_apply_specific_affiliates:
                        type: boolean
                        description: >-
                          Whether the creative is restricted to specific
                          affiliates.
                      additional_offer_ids:
                        type: string
                        description: >-
                          Comma-separated list of additional offer IDs this
                          creative applies to.
                      email_from:
                        type: string
                        description: Email "from" address for email creatives.
                      email_from_lines:
                        type: string
                        description: Email "from" address lines for email creatives.
                      email_subject:
                        type: string
                        description: Email subject line for email creatives.
                      email_subject_lines:
                        type: string
                        description: Email subject lines for email creatives.
                      time_created:
                        type: integer
                        example: 1734455015
                        description: Unix timestamp when the creative was created.
                      time_saved:
                        type: integer
                        example: 1734455015
                        description: Unix timestamp of the last update to the creative.
            reporting:
              type: object
              description: Aggregated performance reporting data for the offer.
              properties:
                total_click:
                  type: integer
                  description: Total number of clicks.
                unique_click:
                  type: integer
                  description: Number of unique clicks.
                invalid_click:
                  type: integer
                  description: Number of invalid/flagged clicks.
                cv:
                  type: integer
                  description: Total conversions.
                cvr:
                  type: number
                  format: float
                  description: Conversion rate.
                evr:
                  type: number
                  format: float
                  description: Event rate.
                event:
                  type: integer
                  description: Total events.
                ctr:
                  type: number
                  format: float
                  description: Click-through rate.
                cost:
                  type: number
                  format: float
                  description: Total cost.
                cpc:
                  type: number
                  format: float
                  description: Cost per click.
                cpm:
                  type: number
                  format: float
                  description: Cost per mille (thousand impressions).
                imp:
                  type: integer
                  description: Total impressions.
                gross_sales:
                  type: number
                  format: float
                  description: Total gross sales amount.
            revenues:
              type: object
              description: Revenue configuration entries for the offer.
              properties:
                total:
                  type: integer
                  description: Total number of revenue entries.
                entries:
                  type: array
                  description: Array of revenue entry objects.
                  items:
                    type: object
                    properties:
                      revenue_type:
                        type: string
                        description: Type of revenue (e.g. cpa_flat, cpa_percentage, cpc).
                      entry_name:
                        type: string
                        description: Name of the revenue entry.
                      revenue_amount:
                        type: number
                        format: float
                        description: Fixed revenue amount (for flat revenue types).
                      revenue_percentage:
                        type: number
                        format: float
                        description: >-
                          Revenue percentage (for percentage-based revenue
                          types).
            ruleset:
              type: object
              description: >-
                Targeting and rule configuration including geo, device, browser,
                and day-parting rules.
            remaining_caps:
              type: object
              description: >-
                Remaining cap values for the offer across all cap types and time
                periods.
              properties:
                remaining_daily_conversion_cap:
                  type: integer
                  description: Remaining daily conversion cap.
                remaining_weekly_conversion_cap:
                  type: integer
                  description: Remaining weekly conversion cap.
                remaining_monthly_conversion_cap:
                  type: integer
                  description: Remaining monthly conversion cap.
                remaining_global_conversion_cap:
                  type: integer
                  description: Remaining global conversion cap.
                remaining_daily_revenue_cap:
                  type: integer
                  description: Remaining daily revenue cap.
                remaining_weekly_revenue_cap:
                  type: integer
                  description: Remaining weekly revenue cap.
                remaining_monthly_revenue_cap:
                  type: integer
                  description: Remaining monthly revenue cap.
                remaining_global_revenue_cap:
                  type: integer
                  description: Remaining global revenue cap.
                remaining_daily_click_cap:
                  type: integer
                  description: Remaining daily click cap.
                remaining_weekly_click_cap:
                  type: integer
                  description: Remaining weekly click cap.
                remaining_monthly_click_cap:
                  type: integer
                  description: Remaining monthly click cap.
                remaining_global_click_cap:
                  type: integer
                  description: Remaining global click cap.
                remaining_daily_payout_cap:
                  type: integer
                  description: Remaining daily payout cap.
                remaining_weekly_payout_cap:
                  type: integer
                  description: Remaining weekly payout cap.
                remaining_monthly_payout_cap:
                  type: integer
                  description: Remaining monthly payout cap.
                remaining_global_payout_cap:
                  type: integer
                  description: Remaining global payout cap.
            meta:
              type: object
              description: >-
                App store metadata including platform, bundle ID, ratings, and
                developer info.
            urls:
              type: object
              description: Offer destination URLs.
              properties:
                total:
                  type: integer
                  description: Total number of URLs.
                entries:
                  type: array
                  description: Array of URL entry objects.
                  items:
                    type: object
            email:
              type: object
              description: Email configuration for the offer.
              properties:
                network_id:
                  type: integer
                  description: Network ID.
                network_offer_id:
                  type: integer
                  description: Offer ID.
                is_enabled:
                  type: boolean
                  description: Whether email is enabled for this offer.
                from_lines:
                  type: string
                  description: Approved from lines for email sends.
                subject_lines:
                  type: string
                  description: Approved subject lines for email sends.
  securitySchemes:
    API Key:
      description: >
        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.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey

````