Skip to main content
GET
Orders

Authorizations

X-API-Key
string
header
required

Your API key from the Studio Dashboard

Query Parameters

page
integer
default:1

Page number, 1-indexed.

Required range: x >= 1
page_size
integer
default:50

Items per page. Default 50, max 100.

Required range: 1 <= x <= 100
order_id
string

Filter by order public ID

of_account_id
integer

Filter by OnlyFans account ID

status
enum<string>

Filter by order status

Available options:
waiting,
active,
rejected,
completed
offer_id
integer

Filter by numeric offer id.

creative_public_id
string

Filter by creative public id (e.g. cpcr_p1bzku7u). Only orders running on this specific creative are returned. Take the value from the response's creative.public_id field or from the studio UI.

since_changed_at
integer

Delta-sync filter. Return only rows whose changed_at is at or after this UNIX timestamp. Pair with until_changed_at for a window.

Required range: x >= 0
until_changed_at
integer

Delta-sync filter. Return only rows whose changed_at is strictly before this UNIX timestamp. Useful to lock the upper bound while paginating an open delta range.

Required range: x >= 0
sort
enum<string>
default:created_at_desc

Sort order.

  • created_at_desc: newest orders first (default).
  • created_at_asc: oldest orders first.
  • changed_at_desc: most recently changed first (delta-sync friendly).
  • changed_at_asc: least recently changed first.
  • completed_at_desc: most recently completed first.
  • clicks_desc: by ordered click count, descending.
  • clicks_delivered_desc: by actually delivered clicks (lifetime), descending.
  • clicks_today_desc: by clicks delivered since today's UTC midnight, descending (real-time).
Available options:
created_at_desc,
created_at_asc,
changed_at_desc,
changed_at_asc,
completed_at_desc,
clicks_desc,
clicks_delivered_desc,
clicks_today_desc

Response

Successful response

success
boolean
Example:

true

data
object[]
pagination
object

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