{
"id": "664f1a2b3c4d5e6f7a8b9c0d",
"slug": "ofr_summer-promo_a1b2c3",
"name": "Summer Promo",
"tracking_url": "https://track.example.com/click?offer_id=123",
"external_platform": "tune",
"external_id": "4521",
"platform_config_id": "665a0c1d2e3f4a5b6c7d8e9f",
"advertiser_id": "adv_882",
"advertiser_name": "Acme Health",
"payout": 2.50,
"payout_type": "cpa",
"filter_bots": true,
"status": "active",
"metadata": {
"vertical": "health",
"geo": "US"
},
"excluded_days_of_week": ["saturday", "sunday"],
"day_parting_enabled": true,
"day_parting": {
"monday": [{"start": "09:00", "end": "17:00"}]
},
"created_at": "2025-11-01T14:30:00",
"updated_at": "2025-12-15T09:12:00"
}
{
"error": "Offer not found",
"code": "not_found"
}
{
"error": "Invalid credentials",
"code": "invalid_credentials"
}
Offers (v2)
Get Offer
Retrieve a single offer by its unique ID.
GET
/
v2
/
offers
/
{id}
{
"id": "664f1a2b3c4d5e6f7a8b9c0d",
"slug": "ofr_summer-promo_a1b2c3",
"name": "Summer Promo",
"tracking_url": "https://track.example.com/click?offer_id=123",
"external_platform": "tune",
"external_id": "4521",
"platform_config_id": "665a0c1d2e3f4a5b6c7d8e9f",
"advertiser_id": "adv_882",
"advertiser_name": "Acme Health",
"payout": 2.50,
"payout_type": "cpa",
"filter_bots": true,
"status": "active",
"metadata": {
"vertical": "health",
"geo": "US"
},
"excluded_days_of_week": ["saturday", "sunday"],
"day_parting_enabled": true,
"day_parting": {
"monday": [{"start": "09:00", "end": "17:00"}]
},
"created_at": "2025-11-01T14:30:00",
"updated_at": "2025-12-15T09:12:00"
}
{
"error": "Offer not found",
"code": "not_found"
}
{
"error": "Invalid credentials",
"code": "invalid_credentials"
}
Returns the full details of a specific offer. The offer must belong to your account.
Path Parameters
string
required
The unique identifier of the offer.
Response Fields
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.datetime
ISO 8601 timestamp of when the offer was created.
datetime
ISO 8601 timestamp of the last update.
Examples
cURL
curl -X GET "https://api.tracklysms.com/api/v2/offers/664f1a2b3c4d5e6f7a8b9c0d" \
-H "X-Api-Key: trk_your_api_key_here"
Python
import requests
offer_id = "664f1a2b3c4d5e6f7a8b9c0d"
response = requests.get(
f"https://api.tracklysms.com/api/v2/offers/{offer_id}",
headers={"X-Api-Key": "trk_your_api_key_here"}
)
offer = response.json()
print(offer["name"], offer["status"])
Node.js
const offerId = "664f1a2b3c4d5e6f7a8b9c0d";
const response = await fetch(
`https://api.tracklysms.com/api/v2/offers/${offerId}`,
{
headers: {
"X-Api-Key": "trk_your_api_key_here"
}
}
);
const offer = await response.json();
console.log(offer.name, offer.status);
{
"id": "664f1a2b3c4d5e6f7a8b9c0d",
"slug": "ofr_summer-promo_a1b2c3",
"name": "Summer Promo",
"tracking_url": "https://track.example.com/click?offer_id=123",
"external_platform": "tune",
"external_id": "4521",
"platform_config_id": "665a0c1d2e3f4a5b6c7d8e9f",
"advertiser_id": "adv_882",
"advertiser_name": "Acme Health",
"payout": 2.50,
"payout_type": "cpa",
"filter_bots": true,
"status": "active",
"metadata": {
"vertical": "health",
"geo": "US"
},
"excluded_days_of_week": ["saturday", "sunday"],
"day_parting_enabled": true,
"day_parting": {
"monday": [{"start": "09:00", "end": "17:00"}]
},
"created_at": "2025-11-01T14:30:00",
"updated_at": "2025-12-15T09:12:00"
}
{
"error": "Offer not found",
"code": "not_found"
}
{
"error": "Invalid credentials",
"code": "invalid_credentials"
}
Error Codes
| HTTP Status | Error Code | Description |
|---|---|---|
| 401 | invalid_credentials | API key is missing or invalid. |
| 403 | account_suspended | Your account is suspended. Resolve outstanding billing or contact support. |
| 404 | not_found | No offer exists with the specified ID. |
| 500 | server_error | An unexpected error occurred on the server. |
Next Steps
Offers Overview
Manage offers and payouts
Record Revenue
Track revenue for this offer