Skip to main content
POST
/
networks
/
offergroupstable
Find Offer Groups (Advanced)
curl --request POST \
  --url https://api.eflow.team/v1/networks/offergroupstable \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "search_terms": [
    {
      "search_type": "name",
      "value": "<string>"
    }
  ],
  "filters": {
    "network_advertiser_ids": [
      123
    ],
    "network_offer_ids": [
      123
    ],
    "offer_group_status": "active"
  },
  "network_offer_group_ids": [
    123
  ],
  "order_field": "name",
  "order_direction": "asc"
}
'
{
  "offer_groups": [
    {
      "network_offer_group_id": 123,
      "network_id": 123,
      "network_advertiser_id": 123,
      "name": "<string>",
      "offer_group_status": "active",
      "offer_count": 123,
      "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_revenue_cap": 123,
      "weekly_revenue_cap": 123,
      "monthly_revenue_cap": 123,
      "global_revenue_cap": 123,
      "daily_click_cap": 123,
      "weekly_click_cap": 123,
      "monthly_click_cap": 123,
      "global_click_cap": 123,
      "today_clicks": 123,
      "today_payout": 123,
      "today_revenue": 123,
      "time_created": 1734455015,
      "time_saved": 1734455015,
      "relationship": {
        "remaining_caps": {
          "remaining_daily_payout_cap": 123,
          "remaining_daily_revenue_cap": 123,
          "remaining_daily_conversion_cap": 123,
          "remaining_daily_click_cap": 123,
          "remaining_weekly_payout_cap": 123,
          "remaining_weekly_revenue_cap": 123,
          "remaining_weekly_conversion_cap": 123,
          "remaining_weekly_click_cap": 123,
          "remaining_monthly_payout_cap": 123,
          "remaining_monthly_revenue_cap": 123,
          "remaining_monthly_conversion_cap": 123,
          "remaining_monthly_click_cap": 123,
          "remaining_global_payout_cap": 123,
          "remaining_global_revenue_cap": 123,
          "remaining_global_conversion_cap": 123,
          "remaining_global_click_cap": 123
        }
      }
    }
  ],
  "paging": {
    "page": 123,
    "page_size": 123,
    "total_count": 123
  }
}
Retrieve a paginated list of offer groups. Supports search filters, sorting, and pagination to help you find and browse offer groups programmatically.

Authorizations

​
X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Query Parameters

​
page
integer
default:1

Page number (1-based).

​
page_size
integer
default:50

Number of results per page.

Body

application/json
​
search_terms
object[]

Text search filters.

​
filters
object

Structured filters to narrow results.

​
network_offer_group_ids
integer[]

Filter by specific offer group IDs.

​
order_field
enum<string>

Field to sort results by.

Available options:
name,
network_offer_group_id,
offer_group_status,
network_advertiser_id,
time_created,
time_saved
​
order_direction
enum<string>

Sort direction.

Available options:
asc,
desc

Response

200 - application/json
​
offer_groups
object[]
​
paging
object