> ## 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 specific offer by its network ID and offer ID. Returns the full offer object with all relationship data. ## OpenAPI ````yaml openapi/marketplace-offers.yaml get /partners/offers/{networkId}/{offerId} openapi: 3.0.3 info: title: Everflow Marketplace API - Offers description: > Marketplace offer endpoints for the Everflow partner marketing platform. Retrieve runnable offers across all marketplace connections. For marketplace concepts, see the [Marketplace guide](https://helpdesk.everflow.io/customer/what-is-the-everflow-marketplace-for-partners). version: 1.0.0 servers: - description: Production Server url: https://api.eflow.team/v1 security: [] tags: - name: Marketplace Offers description: Endpoints for retrieving marketplace offers. paths: /partners/offers/{networkId}/{offerId}: get: tags: - Marketplace Offers summary: Get Offer By ID parameters: - in: path name: networkId required: true schema: type: integer description: The network ID that owns the offer. - 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 - payouts - ruleset - urls - channels - creative_bundle - remaining_caps - custom_payout_settings description: >- Include related data in the response. Repeat for multiple relationships. responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/MarketplaceOffer' '404': description: Offer not found or not runnable for this partner. security: - API Key: [] components: schemas: MarketplaceOffer: 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. offer_status: type: string enum: - active - paused - pending - deleted description: Current status of the offer. thumbnail_url: type: string description: Offer thumbnail image URL. network_category_id: type: integer description: Category ID for the offer. preview_url: type: string description: Preview URL for the offer landing page. 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. is_caps_enabled: type: boolean description: Whether caps are enabled 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_payout_cap: type: integer description: Maximum payout amount per day. 0 means unlimited. weekly_payout_cap: type: integer description: Maximum payout amount per week. 0 means unlimited. monthly_payout_cap: type: integer description: Maximum payout amount per month. 0 means unlimited. global_payout_cap: type: integer description: Maximum total payout 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 click tracking URL used to route traffic. impression_tracking_url: type: string description: URL for tracking impressions. redirect_tracking_url: type: string description: URL for redirect-based tracking. 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. app_identifier: type: string description: App identifier. caps_timezone_id: type: integer description: Timezone ID for cap calculations. date_live_until: type: string description: Offer expiration date (empty string if none). is_description_plain_text: type: boolean description: Whether description is plain text. is_force_terms_and_conditions: type: boolean description: Whether terms acceptance is forced. is_use_direct_linking: type: boolean description: Whether direct linking is allowed. is_using_explicit_terms_and_conditions: type: boolean description: Whether offer has explicit terms and conditions. is_using_suppression_list: type: boolean description: Whether offer uses suppression list. network_tracking_domain_id: type: integer description: Tracking domain ID. suppression_list_id: type: integer description: Suppression list ID (0 if none). terms_and_conditions: type: string description: Terms and conditions text. relationship: type: object description: > Related data included in the response. The list endpoint and single-offer endpoint return slightly different default relationship keys. properties: blocked_variables_count: type: integer description: Count of blocked variables. 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 of when the category was created. time_saved: type: integer example: 1734455015 description: Unix timestamp of the last update to the category. channels: type: object description: Channels associated with this offer. properties: entries: type: array items: type: object properties: network_channel_id: type: integer description: Unique channel ID. network_id: type: integer description: Network ID that owns this channel. name: type: string description: Channel name. status: type: string description: Channel status. time_created: type: integer example: 1734455015 description: Unix timestamp of when the channel was created. time_saved: type: integer example: 1734455015 description: Unix timestamp of the last update to the channel. total: type: integer creative_bundle: type: object description: Creative bundle information. properties: url: type: string description: URL to download the creative bundle archive. creatives: type: object description: Creatives associated with this offer. properties: entries: type: array items: type: object properties: network_offer_creative_id: type: integer description: Unique creative ID. network_id: type: integer description: Network ID that owns this creative. 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. width: type: integer description: Width in pixels (for image/banner creatives). height: type: integer description: Height in pixels (for image/banner creatives). resource_url: type: string description: URL of the creative resource file. html_code: type: string description: HTML code for HTML creatives. 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. email_subject: type: string description: Email subject line for email creatives. email_subject_lines: type: string description: Additional email subject lines. email_from: type: string description: Email from address for email creatives. email_from_lines: type: string description: Additional email from lines. additional_offer_ids: type: string description: Additional offer IDs associated with this creative. time_created: type: integer example: 1734455015 description: Unix timestamp of when the creative was created. time_saved: type: integer example: 1734455015 description: Unix timestamp of the last update to the creative. total: type: integer custom_payout_settings: type: object description: Custom payout settings for this offer. properties: entries: type: array items: type: object total: type: integer email: type: object description: Email configuration. Only present on the single-offer endpoint. properties: network_id: type: integer description: Network ID. network_offer_id: type: integer description: Offer ID. is_enabled: type: boolean description: Whether email creatives are enabled. from_lines: type: string description: Default email from lines. subject_lines: type: string description: Default email subject lines. email_optout: type: object description: >- Email opt-out settings. Only present on the single-offer endpoint. properties: network_id: type: integer description: Network ID. network_offer_id: type: integer description: Offer ID. is_enabled: type: boolean description: Whether email opt-out is enabled. unsub_link: type: string description: Unsubscribe link URL. suppression_file_link: type: string description: Suppression file download link. integrations: type: object description: >- Third-party integrations. Only present on the single-offer endpoint. properties: invoca: type: object description: Invoca integration settings. properties: enabled: type: boolean description: Whether Invoca integration is enabled. retreaver: type: object description: Retreaver integration settings. ringa: type: object description: Ringa integration settings. ezepo: type: object description: Ezepo integration settings. optizmo: type: object description: Optizmo integration settings. unsubcentral: type: object description: UnsubCentral integration settings. meta: type: object description: App store metadata. properties: network_id: type: integer description: Network ID. network_offer_id: type: integer description: Offer ID. meta_platform: type: string description: App store platform (e.g. ios, android). app_id: type: string description: App store application ID. bundle_id: type: string description: App bundle identifier. store_url: type: string description: App store URL. category: type: string description: App store category. developer: type: string description: App developer name. version: type: string description: App version. size: type: integer description: App size. score_rating: type: number description: App rating score. total_rating: type: integer description: Total number of ratings. advertiser_campaign_name: type: string description: Advertiser campaign name. is_app_unavailable: type: boolean description: Whether the app is unavailable in the store. time_app_data_saved: type: integer example: 1734455015 description: Unix timestamp of when app data was last fetched. time_created: type: integer example: 1734455015 description: Unix timestamp of when the metadata was created. time_saved: type: integer example: 1734455015 description: Unix timestamp of the last update to the metadata. network: type: object description: Network information. Only present on the list endpoint. properties: network_id: type: integer description: Network ID. displayed_name: type: string description: Display name of the network. offer_affiliate_status: type: string description: >- Affiliate's approval status for this offer (e.g. "public", "approved"). payouts: type: object description: Payout configurations for this offer. properties: entries: type: array items: type: object properties: network_offer_payout_revenue_id: type: integer description: Unique payout/revenue entry ID. entry_name: type: string description: Name of the payout entry. payout_type: type: string description: Payout type (e.g. cpa, cpc, cpi). payout_amount: type: number description: Payout amount per conversion. payout_percentage: type: number description: Payout percentage (for revshare). is_default: type: boolean description: Whether this is the default payout entry. is_enforce_caps: type: boolean description: Whether caps are enforced for this payout. is_postback_disabled: type: boolean description: Whether postback is disabled for this payout. network_custom_payout_revenue_setting_id: type: integer description: Custom payout revenue setting ID. custom_payout_overwrite: type: boolean description: >- Whether this entry overrides the default custom payout revenue setting. total: type: integer remaining_caps: type: object description: Remaining cap amounts. properties: remaining_daily_conversion_cap: type: integer description: Remaining daily conversion cap. -1 means unlimited. remaining_daily_payout_cap: type: number description: Remaining daily payout cap. -1 means unlimited. remaining_daily_click_cap: type: integer description: Remaining daily click cap. -1 means unlimited. reporting: type: object description: Reporting metrics for this offer. properties: imp: type: integer description: Total impressions. total_click: type: integer description: Total clicks. unique_click: type: integer description: Unique clicks. duplicate_click: type: integer description: Duplicate clicks. invalid_click: type: integer description: Invalid or flagged clicks. cv: type: integer description: Total conversions. event: type: integer description: Total events. view_through_cv: type: integer description: View-through conversions. ctr: type: number description: Click-through rate. cvr: type: number description: Conversion rate. evr: type: number description: Event rate. revenue: type: number description: Total revenue. rpc: type: number description: Revenue per click. rpm: type: number description: Revenue per mille (thousand impressions). on_hold_conversion_count: type: integer description: Number of conversions on hold. on_hold_potential_revenue: type: number description: Potential revenue from on-hold conversions. redirect_traffic_revenue: type: number description: Revenue from redirect traffic. requirement_kpis: type: object description: KPI requirements. properties: entries: type: array items: type: object total: type: integer requirement_tracking_parameters: type: object description: Required tracking parameters. properties: entries: type: array items: type: object total: type: integer ruleset: type: object description: Targeting ruleset for this offer. properties: network_ruleset_id: type: integer description: Unique ruleset ID. network_id: type: integer description: Network ID. is_block_proxy: type: boolean description: Whether proxy traffic is blocked. is_use_day_parting: type: boolean description: Whether day parting is enabled. day_parting_apply_to: type: string description: What day parting applies to. day_parting_timezone_id: type: integer description: Timezone ID for day parting. days_parting: type: array description: Day parting schedule entries. items: type: object countries: type: array description: Targeted countries. items: type: object regions: type: array description: Targeted regions/states. items: type: object cities: type: array description: Targeted cities. items: type: object dmas: type: array description: Targeted DMA regions. items: type: object postal_codes: type: array description: Targeted postal codes. items: type: object ips: type: array description: Targeted IP addresses or ranges. items: type: object platforms: type: array description: Targeted operating system platforms. items: type: object properties: network_targeting_platform_id: type: integer description: Unique targeting platform entry ID. network_id: type: integer description: Network ID. platform_id: type: integer description: Platform ID. label: type: string description: Platform label (e.g. iOS, Android). match_type: type: string description: Match type (e.g. include, exclude). targeting_type: type: string description: Targeting type. os_versions: type: array description: Targeted OS versions. items: type: object properties: network_targeting_os_version_id: type: integer description: Unique targeting OS version entry ID. network_id: type: integer description: Network ID. os_version_id: type: integer description: OS version ID. platform_id: type: integer description: Platform ID this version belongs to. label: type: string description: OS version label (e.g. iOS 14.0+). match_type: type: string description: Match type (e.g. include, exclude). targeting_type: type: string description: Targeting type. browsers: type: array description: Targeted browsers. items: type: object properties: network_targeting_browser_id: type: integer description: Unique targeting browser entry ID. network_id: type: integer description: Network ID. browser_id: type: integer description: Browser ID. label: type: string description: Browser label (e.g. Chrome, Safari). match_type: type: string description: Match type (e.g. include, exclude). targeting_type: type: string description: Targeting type. device_types: type: array description: Targeted device types. items: type: object properties: network_targeting_device_type_id: type: integer description: Unique targeting device type entry ID. network_id: type: integer description: Network ID. device_type_id: type: integer description: Device type ID. label: type: string description: Device type label (e.g. Mobile, Desktop). match_type: type: string description: Match type (e.g. include, exclude). targeting_type: type: string description: Targeting type. brands: type: array description: Targeted device brands. items: type: object languages: type: array description: Targeted browser languages. items: type: object properties: network_targeting_browser_language_id: type: integer description: Unique targeting language entry ID. network_id: type: integer description: Network ID. browser_language_id: type: integer description: Browser language ID. label: type: string description: Language label (e.g. English, French). match_type: type: string description: Match type (e.g. include, exclude). targeting_type: type: string description: Targeting type. mobile_carriers: type: array description: Targeted mobile carriers. items: type: object connection_types: type: array description: Targeted connection types. items: type: object isps: type: array description: Targeted ISPs. items: type: object time_created: type: integer example: 1734455015 description: Unix timestamp of when the ruleset was created. time_saved: type: integer example: 1734455015 description: Unix timestamp of the last update to the ruleset. suppression_file_asset: type: object description: >- Suppression file asset. Only present on the single-offer endpoint. properties: network_asset_id: type: integer description: Unique asset ID. filename: type: string description: Original filename. url: type: string description: URL to download the asset. content_type: type: string description: MIME content type. file_size: type: integer description: File size in bytes. image_width: type: integer description: Image width in pixels (0 if not an image). image_height: type: integer description: Image height in pixels (0 if not an image). optimized_thumbnail_url: type: string description: Optimized thumbnail URL. thumbnail_asset: type: object description: Thumbnail asset. properties: network_asset_id: type: integer description: Unique asset ID. filename: type: string description: Original filename. url: type: string description: URL to download the asset. content_type: type: string description: MIME content type. file_size: type: integer description: File size in bytes. image_width: type: integer description: Image width in pixels. image_height: type: integer description: Image height in pixels. optimized_thumbnail_url: type: string description: Optimized thumbnail URL. today_revenue: type: string description: >- Today's revenue formatted as a string (e.g. "CLP $0.00"). Only present on the list endpoint. urls: type: object description: Offer URLs. properties: entries: type: array items: type: object properties: network_offer_url_id: type: integer description: Unique offer URL ID. network_id: type: integer description: Network ID. network_offer_id: type: integer description: Offer ID this URL belongs to. name: type: string description: URL name or label. preview_url: type: string description: Preview URL for this landing page. total: type: integer securitySchemes: API Key: description: > The marketplace partner's API key. Uses the X-Eflow-Api-Key header. The key belongs to the marketplace partner user. in: header name: X-Eflow-Api-Key type: apiKey ````