Skip to main content
GET
Offer orders

Authorizations

X-API-Key
string
header
required

Your API key from the Studio Dashboard

Path Parameters

id
integer
required

Numeric resource id.

Required range: x >= 1

Query Parameters

page
integer
default:1

Page number, 1-indexed.

Required range: x >= 1
page_size
integer
default:25
Required range: 1 <= x <= 100
sort
enum<string>
default:date_desc

Sort order.

  • date_desc: newest orders first (by campaign end date; default).
  • date_asc: oldest orders first.
  • price_desc: highest price first.
  • price_asc: lowest price first.
  • romi_desc: best return on marketing investment first. Orders where ROMI is hidden (either party opted out) always sort to the bottom; if the offer hides ROMI globally, the API falls back to date_desc.
  • dialogs_desc: most dialogs (3-message threshold) first.
Available options:
date_desc,
date_asc,
price_desc,
price_asc,
romi_desc,
dialogs_desc

Response

Successful response. Capped at the 500 most-recent matching rows; pagination.total reflects that cap, not the absolute count of orders ever placed on this offer.

success
boolean
Example:

true

data
object[]
pagination
object

Page-based pagination, returned by every list endpoint that isn't a cursor feed.