Skip to main content
GET
/
partners
/
offersrunnable
Find All Runnable Offers
curl --request GET \
  --url https://api.eflow.team/v1/partners/offersrunnable \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "filters": {
    "categories": [
      "Business"
    ],
    "payout_types": [
      "cpa"
    ]
  },
  "search_terms": [
    {
      "search_type": "offer_name",
      "value": "my offer"
    }
  ]
}
'
{
  "offers": [
    {
      "network_offer_id": 123,
      "network_id": 123,
      "name": "<string>",
      "offer_status": "active",
      "thumbnail_url": "<string>",
      "network_category_id": 123,
      "preview_url": "<string>",
      "currency_id": "<string>",
      "html_description": "<string>",
      "visibility": "public",
      "is_caps_enabled": true,
      "daily_conversion_cap": 123,
      "weekly_conversion_cap": 123,
      "monthly_conversion_cap": 123,
      "global_conversion_cap": 123,
      "daily_payout_cap": 123,
      "weekly_payout_cap": 123,
      "monthly_payout_cap": 123,
      "global_payout_cap": 123,
      "daily_click_cap": 123,
      "weekly_click_cap": 123,
      "monthly_click_cap": 123,
      "global_click_cap": 123,
      "tracking_url": "<string>",
      "impression_tracking_url": "<string>",
      "redirect_tracking_url": "<string>",
      "time_created": 1734455015,
      "time_saved": 1734455015,
      "app_identifier": "<string>",
      "caps_timezone_id": 123,
      "date_live_until": "<string>",
      "is_description_plain_text": true,
      "is_force_terms_and_conditions": true,
      "is_use_direct_linking": true,
      "is_using_explicit_terms_and_conditions": true,
      "is_using_suppression_list": true,
      "network_tracking_domain_id": 123,
      "suppression_list_id": 123,
      "terms_and_conditions": "<string>",
      "relationship": {
        "blocked_variables_count": 123,
        "category": {
          "network_category_id": 123,
          "network_id": 123,
          "name": "<string>",
          "status": "<string>",
          "time_created": 1734455015,
          "time_saved": 1734455015
        },
        "channels": {
          "entries": [
            {
              "network_channel_id": 123,
              "network_id": 123,
              "name": "<string>",
              "status": "<string>",
              "time_created": 1734455015,
              "time_saved": 1734455015
            }
          ],
          "total": 123
        },
        "creative_bundle": {
          "url": "<string>"
        },
        "creatives": {
          "entries": [
            {
              "network_offer_creative_id": 123,
              "network_id": 123,
              "network_offer_id": 123,
              "name": "<string>",
              "creative_type": "<string>",
              "creative_status": "<string>",
              "width": 123,
              "height": 123,
              "resource_url": "<string>",
              "html_code": "<string>",
              "is_private": true,
              "is_apply_specific_affiliates": true,
              "email_subject": "<string>",
              "email_subject_lines": "<string>",
              "email_from": "<string>",
              "email_from_lines": "<string>",
              "additional_offer_ids": "<string>",
              "time_created": 1734455015,
              "time_saved": 1734455015
            }
          ],
          "total": 123
        },
        "custom_payout_settings": {
          "entries": [
            {}
          ],
          "total": 123
        },
        "email": {
          "network_id": 123,
          "network_offer_id": 123,
          "is_enabled": true,
          "from_lines": "<string>",
          "subject_lines": "<string>"
        },
        "email_optout": {
          "network_id": 123,
          "network_offer_id": 123,
          "is_enabled": true,
          "unsub_link": "<string>",
          "suppression_file_link": "<string>"
        },
        "integrations": {
          "invoca": {
            "enabled": true
          },
          "retreaver": {},
          "ringa": {},
          "ezepo": {},
          "optizmo": {},
          "unsubcentral": {}
        },
        "meta": {
          "network_id": 123,
          "network_offer_id": 123,
          "meta_platform": "<string>",
          "app_id": "<string>",
          "bundle_id": "<string>",
          "store_url": "<string>",
          "category": "<string>",
          "developer": "<string>",
          "version": "<string>",
          "size": "<string>",
          "score_rating": 123,
          "total_rating": 123,
          "advertiser_campaign_name": "<string>",
          "is_app_unavailable": true,
          "time_app_data_saved": 1734455015,
          "time_created": 1734455015,
          "time_saved": 1734455015
        },
        "network": {
          "network_id": 123,
          "displayed_name": "<string>"
        },
        "offer_affiliate_status": "<string>",
        "payouts": {
          "entries": [
            {
              "network_offer_payout_revenue_id": 123,
              "entry_name": "<string>",
              "payout_type": "<string>",
              "payout_amount": 123,
              "payout_percentage": 123,
              "is_default": true,
              "is_enforce_caps": true,
              "is_postback_disabled": true,
              "network_custom_payout_revenue_setting_id": 123,
              "custom_payout_overwrite": true
            }
          ],
          "total": 123
        },
        "remaining_caps": {
          "remaining_daily_conversion_cap": 123,
          "remaining_daily_payout_cap": 123,
          "remaining_daily_click_cap": 123
        },
        "reporting": {
          "imp": 123,
          "total_click": 123,
          "unique_click": 123,
          "duplicate_click": 123,
          "invalid_click": 123,
          "cv": 123,
          "event": 123,
          "view_through_cv": 123,
          "ctr": 123,
          "cvr": 123,
          "evr": 123,
          "revenue": 123,
          "rpc": 123,
          "rpm": 123,
          "on_hold_conversion_count": 123,
          "on_hold_potential_revenue": 123,
          "redirect_traffic_revenue": 123
        },
        "requirement_kpis": {
          "entries": [
            {}
          ],
          "total": 123
        },
        "requirement_tracking_parameters": {
          "entries": [
            {}
          ],
          "total": 123
        },
        "ruleset": {
          "network_ruleset_id": 123,
          "network_id": 123,
          "is_block_proxy": true,
          "is_use_day_parting": true,
          "day_parting_apply_to": "<string>",
          "day_parting_timezone_id": 123,
          "days_parting": [
            {}
          ],
          "countries": [
            {}
          ],
          "regions": [
            {}
          ],
          "cities": [
            {}
          ],
          "dmas": [
            {}
          ],
          "postal_codes": [
            {}
          ],
          "ips": [
            {}
          ],
          "platforms": [
            {
              "network_targeting_platform_id": 123,
              "network_id": 123,
              "platform_id": 123,
              "label": "<string>",
              "match_type": "<string>",
              "targeting_type": "<string>"
            }
          ],
          "os_versions": [
            {
              "network_targeting_os_version_id": 123,
              "network_id": 123,
              "os_version_id": 123,
              "platform_id": 123,
              "label": "<string>",
              "match_type": "<string>",
              "targeting_type": "<string>"
            }
          ],
          "browsers": [
            {
              "network_targeting_browser_id": 123,
              "network_id": 123,
              "browser_id": 123,
              "label": "<string>",
              "match_type": "<string>",
              "targeting_type": "<string>"
            }
          ],
          "device_types": [
            {
              "network_targeting_device_type_id": 123,
              "network_id": 123,
              "device_type_id": 123,
              "label": "<string>",
              "match_type": "<string>",
              "targeting_type": "<string>"
            }
          ],
          "brands": [
            {}
          ],
          "languages": [
            {
              "network_targeting_browser_language_id": 123,
              "network_id": 123,
              "browser_language_id": 123,
              "label": "<string>",
              "match_type": "<string>",
              "targeting_type": "<string>"
            }
          ],
          "mobile_carriers": [
            {}
          ],
          "connection_types": [
            {}
          ],
          "isps": [
            {}
          ],
          "time_created": 1734455015,
          "time_saved": 1734455015
        },
        "suppression_file_asset": {
          "network_asset_id": 123,
          "filename": "<string>",
          "url": "<string>",
          "content_type": "<string>",
          "file_size": 123,
          "image_width": 123,
          "image_height": 123,
          "optimized_thumbnail_url": "<string>"
        },
        "thumbnail_asset": {
          "network_asset_id": 123,
          "filename": "<string>",
          "url": "<string>",
          "content_type": "<string>",
          "file_size": 123,
          "image_width": 123,
          "image_height": 123,
          "optimized_thumbnail_url": "<string>"
        },
        "today_revenue": "<string>",
        "urls": {
          "entries": [
            {
              "network_offer_url_id": 123,
              "network_id": 123,
              "network_offer_id": 123,
              "name": "<string>",
              "preview_url": "<string>"
            }
          ],
          "total": 123
        }
      }
    }
  ],
  "paging": {
    "page": 123,
    "page_size": 123,
    "total_count": 123
  },
  "last_sync": 123
}

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.

Retrieve all runnable offers across all marketplace connections. Page size is capped at 20. Each offer includes full tracking URLs, creative bundles, payout details, and targeting rulesets. Supports pagination via page and page_size query parameters. Use the relationship query parameter to include related data. Accepts an optional JSON request body for filtering and searching.

Authorizations

X-Eflow-Api-Key
string
header
required

The marketplace partner's API key. Uses the X-Eflow-Api-Key header. The key belongs to the marketplace partner user.

Query Parameters

page
integer
default:1

Page number (1-based).

page_size
integer
default:20

Number of results per page (max 20).

Required range: x <= 20
relationship
enum<string>

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

Available options:
category,
creatives,
reporting,
payouts,
ruleset,
urls,
channels,
creative_bundle,
remaining_caps,
custom_payout_settings

Body

application/json
filters
object

Filters to narrow the offer results.

search_terms
object[]

Text search filters.

Response

200 - application/json
offers
object[]

Array of runnable offer objects.

paging
object
last_sync
integer

Unix timestamp of when the marketplace data was last synced.