Returns all offers associated with your account. By default, archived offers are excluded unless explicitly requested via the status filter.
Query Parameters
string
Filter offers by status. Accepted values: active, paused, archived. When omitted, all non-archived offers are returned.
string
Filter offers by their exact external platform ID.
string
Filter offers by external platform. The value is matched exactly against the offer’s external_platform, so tune, everflow, everflow_marketplace, and other integration-set values all work. A value no offer uses returns an empty list.
string
Return only the offers linked to this platform integration. A malformed ID is rejected with invalid_platform_config; a well-formed ID that is not one of your integrations returns an empty result rather than an error.
integer
default:"1"
Page number for pagination.
integer
default:"50"
Number of offers per page. Maximum value is 100.
Response Fields
array
An array of offer objects.
Show Offer object properties
string
Unique identifier for the offer.
string
Human-readable unique slug for the offer, in the form ofr_{slugified-name}_{hex}.
string
Display name of the offer.
string
The tracking/click URL for this offer.
string
The external affiliate platform this offer syncs with. Values include tune, everflow, everflow_marketplace, or other integration-set platforms, or null when the offer isn’t linked to an external platform.
string
The offer ID on the external platform.
string
ID of the platform integration this offer is linked to, or null when the offer is not linked to one. Only a linked offer is picked up by that integration’s conversion sync.
string
The advertiser ID associated with the offer.
string
The advertiser name associated with the offer.
float
Payout amount for the offer.
string
Payout model. One of cpa or cpc.
boolean
Whether bot click filtering is enabled.
string
Current status of the offer: active, paused, or archived.
object
Custom key-value metadata attached to the offer.
array
Weekday names (lowercase monday through sunday) on which this offer will not be sent, evaluated in the contact’s local time. Empty array when none are excluded.
boolean
Whether intra-day send-window restrictions apply to this offer.
object
Allow-list of send windows keyed by lowercase weekday, evaluated in Eastern Time. Shape: {"monday": [{"start": "HH:MM", "end": "HH:MM"}]}. Empty object when no windows are configured.
string
First day the offer may be sent (YYYY-MM-DD, in dates_timezone), or null. Outside its dates an active offer is treated as inactive and is not sent.
string
Last day the offer may be sent, inclusive (YYYY-MM-DD, in dates_timezone), or null.
string
Timezone the send dates are read in, or null when they follow the account timezone.
datetime
ISO 8601 timestamp of when the offer was created.
datetime
ISO 8601 timestamp of the last update.
object
Pagination metadata.
Show Pagination properties
integer
Current page number.
integer
Number of results per page.
integer
Total number of offers matching the query.
integer
Total number of pages available.
Examples
cURL
curl -X GET "https://api.tracklysms.com/api/v2/offers?status=active&page=1&per_page=25" \ -H "X-Api-Key: trk_your_api_key_here"