openapi: 3.0.3 info: title: Everflow Affiliate API - Offers description: > Offer discovery and tracking URL endpoints for the Everflow Affiliate API. These endpoints allow affiliates to browse visible offers, retrieve details for offers they can run, and generate tracking links. version: 1.0.0 servers: - description: Production Server url: https://api.eflow.team/v1 tags: - name: Affiliate Offers description: Endpoints for discovering and retrieving offer details as an affiliate. paths: /affiliates/alloffers: get: summary: Find All Visible Offers tags: - Affiliate Offers parameters: - name: page in: query description: Page number for pagination (1-based). schema: type: integer default: 1 - name: page_size in: query description: Number of results per page. schema: type: integer default: 50 - name: search in: query description: Search term to filter offers by name or ID. schema: type: string - name: category_id in: query description: Filter by offer category ID. schema: type: integer responses: "200": description: "" content: application/json: schema: type: object properties: offers: type: array description: Array of visible offers. items: type: object properties: network_offer_id: type: integer description: Unique identifier for the offer. network_id: type: integer description: Network ID. name: type: string description: Offer name. offer_status: type: string description: Current status of the offer (e.g. active, paused, deleted). currency_id: type: string description: Currency code for the offer (e.g. "USD"). visibility: type: string description: Visibility setting of the offer (public, require_approval, private). thumbnail_url: type: string description: URL of the offer thumbnail image. html_description: type: string description: Offer description in HTML format. is_description_plain_text: type: boolean description: Whether the description is plain text (true) or HTML (false). preview_url: type: string description: Preview URL for the offer landing page. tracking_url: type: string description: Base tracking URL for the offer. impression_tracking_url: type: string description: Impression tracking URL for the offer. network_category_id: type: integer description: Category ID for the offer. network_tracking_domain_id: type: integer description: Tracking domain ID. app_identifier: type: string description: App store identifier for mobile offers. is_caps_enabled: type: boolean description: Whether caps are enabled for this offer. caps_timezone_id: type: integer description: Timezone ID used for cap calculations. daily_conversion_cap: type: integer description: Daily conversion cap. weekly_conversion_cap: type: integer description: Weekly conversion cap. monthly_conversion_cap: type: integer description: Monthly conversion cap. global_conversion_cap: type: integer description: Global (lifetime) conversion cap. daily_click_cap: type: integer description: Daily click cap. weekly_click_cap: type: integer description: Weekly click cap. monthly_click_cap: type: integer description: Monthly click cap. global_click_cap: type: integer description: Global (lifetime) click cap. daily_payout_cap: type: number description: Daily payout cap. weekly_payout_cap: type: number description: Weekly payout cap. monthly_payout_cap: type: number description: Monthly payout cap. global_payout_cap: type: number description: Global (lifetime) payout cap. is_force_terms_and_conditions: type: boolean description: Whether terms and conditions acceptance is required. is_using_explicit_terms_and_conditions: type: boolean description: Whether the offer uses explicit terms and conditions. terms_and_conditions: type: string description: Terms and conditions text. is_use_direct_linking: type: boolean description: Whether direct linking is enabled. is_using_suppression_list: type: boolean description: Whether a suppression list is in use. suppression_list_id: type: integer description: Suppression list ID. date_live_until: type: string description: Date until which the offer is live. time_created: type: integer description: Timestamp when the offer was created. time_saved: type: integer description: Timestamp when the offer was last saved. relationship: type: object description: Relationship data specific to this affiliate. properties: offer_affiliate_status: type: string description: > Affiliate's relationship status with this offer. Values include: approved, pending, not_applied, rejected, public. paging: type: object description: Pagination metadata. properties: page: type: integer description: Current page number. page_size: type: integer description: Number of results per page. total_count: type: integer description: Total number of matching offers. security: - API Key: [] /affiliates/offersrunnable: get: summary: Find All Runnable Offers tags: - Affiliate Offers parameters: - name: page in: query description: Page number for pagination (1-based). schema: type: integer default: 1 - name: page_size in: query description: Number of results per page. schema: type: integer default: 50 - name: search in: query description: Search term to filter offers by name or ID. schema: type: string responses: "200": description: "" content: application/json: schema: type: object properties: offers: type: array description: Array of runnable offers. items: type: object properties: network_offer_id: type: integer description: Unique identifier for the offer. network_id: type: integer description: Network ID. name: type: string description: Offer name. offer_status: type: string description: Current status of the offer. currency_id: type: string description: Currency code for the offer. visibility: type: string description: Visibility setting of the offer. thumbnail_url: type: string description: URL of the offer thumbnail image. html_description: type: string description: Offer description in HTML format. is_description_plain_text: type: boolean description: Whether the description is plain text or HTML. preview_url: type: string description: Preview URL for the offer landing page. tracking_url: type: string description: Base tracking URL for the offer. redirect_tracking_url: type: string description: Redirect tracking URL for the offer. impression_tracking_url: type: string description: Impression tracking URL for the offer. network_category_id: type: integer description: Category ID for the offer. is_caps_enabled: type: boolean description: Whether caps are enabled for this offer. caps_timezone_id: type: integer description: Timezone ID used for cap calculations. daily_conversion_cap: type: integer description: Daily conversion cap. weekly_conversion_cap: type: integer description: Weekly conversion cap. monthly_conversion_cap: type: integer description: Monthly conversion cap. global_conversion_cap: type: integer description: Global (lifetime) conversion cap. daily_click_cap: type: integer description: Daily click cap. weekly_click_cap: type: integer description: Weekly click cap. monthly_click_cap: type: integer description: Monthly click cap. global_click_cap: type: integer description: Global (lifetime) click cap. daily_payout_cap: type: number description: Daily payout cap. weekly_payout_cap: type: number description: Weekly payout cap. monthly_payout_cap: type: number description: Monthly payout cap. global_payout_cap: type: number description: Global (lifetime) payout cap. is_force_terms_and_conditions: type: boolean description: Whether terms and conditions acceptance is required. is_using_explicit_terms_and_conditions: type: boolean description: Whether the offer uses explicit terms and conditions. terms_and_conditions: type: string description: Terms and conditions text. is_use_direct_linking: type: boolean description: Whether direct linking is enabled. is_using_suppression_list: type: boolean description: Whether a suppression list is in use. suppression_list_id: type: integer description: Suppression list ID. network_tracking_domain_id: type: integer description: Tracking domain ID. app_identifier: type: string description: App store identifier for mobile offers. date_live_until: type: string description: Date until which the offer is live. time_created: type: integer description: Timestamp when the offer was created. time_saved: type: integer description: Timestamp when the offer was last saved. relationship: type: object description: Full relationship data for this affiliate and offer. properties: offer_affiliate_status: type: string description: Affiliate's approval status for this offer. blocked_variables_count: type: integer description: Number of blocked tracking variables. category: type: object description: Offer category details. properties: network_category_id: type: integer network_id: type: integer name: type: string status: type: string time_created: type: integer time_saved: type: integer channels: type: object description: Available traffic channels. properties: entries: type: array items: type: object properties: network_channel_id: type: integer network_id: type: integer name: type: string status: type: string time_created: type: integer time_saved: type: integer total: type: integer creative_bundle: type: object description: Creative bundle information. properties: url: type: string creatives: type: object description: Available creatives for this offer. properties: entries: type: array items: type: object properties: network_offer_creative_id: type: integer network_offer_id: type: integer network_id: type: integer name: type: string creative_type: type: string creative_status: type: string resource_url: type: string html_code: type: string width: type: integer height: type: integer is_private: type: boolean is_apply_specific_affiliates: type: boolean additional_offer_ids: type: string email_from: type: string email_from_lines: type: string email_subject: type: string email_subject_lines: type: string time_created: type: integer time_saved: type: integer total: type: integer custom_payout_settings: type: object description: Custom payout settings. properties: entries: type: array items: type: object total: type: integer meta: type: object description: Additional metadata associated with the offer. payouts: type: object description: Payout configuration for this affiliate. properties: entries: type: array items: type: object properties: network_offer_payout_revenue_id: type: integer network_custom_payout_revenue_setting_id: type: integer entry_name: type: string payout_type: type: string description: Type of payout (CPA, CPC, CPI, RevShare, etc.). payout_amount: type: number description: Payout amount per conversion or event. payout_percentage: type: number description: Payout percentage for RevShare. custom_payout_overwrite: type: boolean is_default: type: boolean is_enforce_caps: type: boolean is_postback_disabled: type: boolean total: type: integer remaining_caps: type: object description: Remaining cap amounts for the current period. properties: remaining_daily_click_cap: type: integer remaining_daily_conversion_cap: type: integer remaining_daily_payout_cap: type: number reporting: type: object description: Aggregated reporting data for this offer. requirement_kpis: type: object description: KPI requirements for the offer. 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 and rule configuration. terms_conditions_acceptance: type: object description: Terms and conditions acceptance status. thumbnail_asset: type: object description: Thumbnail asset details. urls: type: object description: Offer destination URLs. properties: entries: type: array items: type: object properties: network_offer_url_id: type: integer network_offer_id: type: integer network_id: type: integer name: type: string preview_url: type: string total: type: integer paging: type: object properties: page: type: integer page_size: type: integer total_count: type: integer security: - API Key: [] /affiliates/offers/{offerId}: get: summary: Find Offer By ID tags: - Affiliate Offers parameters: - name: offerId in: path required: true description: The numeric ID of the offer. schema: type: integer responses: "200": description: "" content: application/json: schema: type: object properties: network_offer_id: type: integer description: Unique identifier for the offer. network_id: type: integer description: Network ID. name: type: string description: Offer name. offer_status: type: string description: Current status of the offer. currency_id: type: string description: Currency code for the offer. visibility: type: string description: Visibility setting of the offer. html_description: type: string description: Offer description in HTML format. is_description_plain_text: type: boolean description: Whether the description is plain text or HTML. preview_url: type: string description: Preview URL for the offer landing page. tracking_url: type: string description: Base tracking URL. redirect_tracking_url: type: string description: Redirect tracking URL. impression_tracking_url: type: string description: Impression tracking URL. thumbnail_url: type: string description: URL of the offer thumbnail image. network_category_id: type: integer description: Category ID for the offer. is_caps_enabled: type: boolean description: Whether caps are enabled for this offer. caps_timezone_id: type: integer description: Timezone ID used for cap calculations. daily_conversion_cap: type: integer description: Daily conversion cap. weekly_conversion_cap: type: integer description: Weekly conversion cap. monthly_conversion_cap: type: integer description: Monthly conversion cap. global_conversion_cap: type: integer description: Global (lifetime) conversion cap. daily_click_cap: type: integer description: Daily click cap. weekly_click_cap: type: integer description: Weekly click cap. monthly_click_cap: type: integer description: Monthly click cap. global_click_cap: type: integer description: Global (lifetime) click cap. daily_payout_cap: type: number description: Daily payout cap. weekly_payout_cap: type: number description: Weekly payout cap. monthly_payout_cap: type: number description: Monthly payout cap. global_payout_cap: type: number description: Global (lifetime) payout cap. is_force_terms_and_conditions: type: boolean description: Whether terms and conditions acceptance is required. is_using_explicit_terms_and_conditions: type: boolean description: Whether the offer uses explicit terms and conditions. terms_and_conditions: type: string description: Terms and conditions text. is_use_direct_linking: type: boolean description: Whether direct linking is enabled. is_using_suppression_list: type: boolean description: Whether a suppression list is in use. suppression_list_id: type: integer description: Suppression list ID. network_tracking_domain_id: type: integer description: Tracking domain ID. app_identifier: type: string description: App store identifier for mobile offers. date_live_until: type: string description: Date until which the offer is live. time_created: type: integer description: Timestamp when the offer was created. time_saved: type: integer description: Timestamp when the offer was last saved. relationship: type: object description: > Affiliate-specific relationship data. Contains the same keys as the offersrunnable relationship, plus email, email_optout, and integrations. properties: offer_affiliate_status: type: string description: Affiliate's approval status for this offer. blocked_variables_count: type: integer description: Number of blocked tracking variables. category: type: object description: Offer category details. properties: network_category_id: type: integer network_id: type: integer name: type: string status: type: string time_created: type: integer time_saved: type: integer channels: type: object description: Available traffic channels. properties: entries: type: array items: type: object total: type: integer creative_bundle: type: object description: Creative bundle information. properties: url: type: string creatives: type: object description: Available creatives for this offer. properties: entries: type: array items: type: object total: type: integer custom_payout_settings: type: object description: Custom payout settings. properties: entries: type: array items: type: object total: type: integer email: type: object description: Email configuration for the offer. email_optout: type: object description: Email opt-out configuration. integrations: type: object description: Integration configurations for the offer. properties: ezepo: type: object invoca: type: object optizmo: type: object retreaver: type: object ringa: type: object unsubcentral: type: object meta: type: object description: Additional metadata associated with the offer. payouts: type: object description: Payout configuration. properties: entries: type: array items: type: object total: type: integer remaining_caps: type: object description: Remaining cap amounts for the current period. properties: remaining_daily_click_cap: type: integer remaining_daily_conversion_cap: type: integer remaining_daily_payout_cap: type: number reporting: type: object description: Aggregated reporting data for this offer. 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 and rule configuration. terms_conditions_acceptance: type: object description: Terms and conditions acceptance status. thumbnail_asset: type: object description: Thumbnail asset details. urls: type: object description: Offer destination URLs. properties: entries: type: array items: type: object total: type: integer "404": description: Offer not found or not visible to the authenticated affiliate. security: - API Key: [] /affiliates/offers/{offerId}/url/{urlId}: get: summary: Find Tracking URL tags: - Affiliate Offers parameters: - name: offerId in: path required: true description: The numeric ID of the offer. schema: type: integer - name: urlId in: path required: true description: > The destination URL ID. Use 0 for the default offer URL when no extra destination URLs are configured. schema: type: integer responses: "200": description: "" content: application/json: schema: type: object properties: url: type: string description: The full tracking link URL for the affiliate to use. "400": description: Affiliate is not authorized to run this offer. security: - API Key: [] /affiliates/offers/{offerId}/impressionurl/{urlId}: get: summary: Find Impression URL tags: - Affiliate Offers parameters: - name: offerId in: path required: true description: The numeric ID of the offer. schema: type: integer - name: urlId in: path required: true description: > The destination URL ID. Use 0 for the default URL. schema: type: integer responses: "200": description: "" content: application/json: schema: type: object properties: url: type: string description: The full impression tracking URL. "400": description: Affiliate is not authorized to run this offer. security: - API Key: [] /affiliates/offerstable: post: summary: Find Offers (Advanced) tags: - Affiliate Offers parameters: - in: query name: page required: false schema: type: integer minimum: 1 default: 1 description: The page of results to retrieve. - in: query name: page_size required: false schema: type: integer minimum: 1 default: 50 description: The number of results to return per page. requestBody: required: true content: application/json: example: search_terms: [] filters: {} page: 1 page_size: 50 schema: type: object properties: search_terms: type: array description: Search terms to match against offer names and IDs. items: type: object properties: search_type: type: string description: The type of search to perform. value: type: string description: The search value. filters: type: object description: Filters to narrow results. responses: "200": description: "" content: application/json: schema: type: object properties: offers: type: array description: Array of matching offers. items: type: object properties: network_offer_id: type: integer description: Unique identifier for the offer. network_id: type: integer description: Network ID. name: type: string description: Offer name. offer_status: type: string description: Current status of the offer. visibility: type: string description: Visibility setting. currency_id: type: string description: Currency code for the offer. thumbnail_url: type: string description: URL of the offer thumbnail image. optimized_thumbnail_url: type: string description: URL of the optimized offer thumbnail image. destination_url: type: string description: Destination URL for the offer. category: type: string description: Offer category name. channels: type: string description: Traffic channels. network_advertiser_id: type: integer description: Advertiser ID. network_advertiser_name: type: string description: Advertiser name. network_offer_group_id: type: integer description: Offer group ID. caps_timezone_id: type: integer description: Timezone ID used for cap calculations. daily_conversion_cap: type: integer description: Daily conversion cap. weekly_conversion_cap: type: integer description: Weekly conversion cap. monthly_conversion_cap: type: integer description: Monthly conversion cap. global_conversion_cap: type: integer description: Global (lifetime) conversion cap. daily_click_cap: type: integer description: Daily click cap. weekly_click_cap: type: integer description: Weekly click cap. monthly_click_cap: type: integer description: Monthly click cap. global_click_cap: type: integer description: Global (lifetime) click cap. daily_payout_cap: type: number description: Daily payout cap. weekly_payout_cap: type: number description: Weekly payout cap. monthly_payout_cap: type: number description: Monthly payout cap. global_payout_cap: type: number description: Global (lifetime) payout cap. is_default_enforce_caps: type: boolean description: Whether caps are enforced by default. is_force_terms_and_conditions: type: boolean description: Whether terms and conditions acceptance is required. is_using_explicit_terms_and_conditions: type: boolean description: Whether the offer uses explicit terms and conditions. payout: type: string description: Formatted payout display value. payout_type: type: string description: Type of payout (CPA, CPC, CPI, RevShare, etc.). payout_amount: type: number description: Payout amount per conversion or event. payout_percentage: type: number description: Payout percentage for RevShare. ruleset_id: type: integer description: Ruleset ID. today_revenue: type: string description: Revenue earned today. time_created: type: integer description: Timestamp when the offer was created. time_saved: type: integer description: Timestamp when the offer was last saved. relationship: type: object description: Affiliate-specific relationship data. properties: offer_affiliate_status: type: string description: Affiliate's approval status for this offer. custom_payout_settings: type: object description: Custom payout settings. properties: entries: type: array items: type: object total: type: integer events: type: object description: Event payout configurations. properties: entries: type: array items: type: object properties: network_offer_payout_revenue_id: type: integer network_custom_payout_revenue_setting_id: type: integer entry_name: type: string payout_type: type: string payout_amount: type: number payout_percentage: type: number custom_payout_overwrite: type: boolean is_default: type: boolean is_enforce_caps: type: boolean is_postback_disabled: type: boolean total: type: integer remaining_caps: type: object description: Remaining cap amounts for the current period. ruleset: type: object description: Targeting and rule configuration. terms_conditions_acceptance: type: object description: Terms and conditions acceptance status. paging: type: object properties: page: type: integer page_size: type: integer total_count: type: integer security: - API Key: [] components: securitySchemes: API Key: description: > The affiliate's API key generated from the Affiliate Portal. Uses the X-Eflow-Api-Key header. in: header name: X-Eflow-Api-Key type: apiKey