Skip to main content
GET
Campaigns

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
of_account_id
integer

Filter by OnlyFans account id (must be one of your accounts).

campaign_id
string

Filter by campaign public ID (e.g. revc_xxxxx).

marketer_uuid
string<uuid>

Filter to campaigns run by a specific marketer.

status
enum<string>

Filter by campaign status.

Available options:
active,
completed
type
enum<string>

Filter by campaign delivery type.

Available options:
date,
link,
trial,
smartlink,
smartlink_trial,
smartlink_tracking,
second,
shared_link,
shared_trial
source
string

Filter by traffic source the campaign is running on (e.g. instagram, tiktok, reddit). Use other for sources outside the standard catalog.

min_fans
integer

Return only campaigns with at least this many lifetime fans.

Required range: x >= 0
min_income
number

Return only campaigns whose total income is at least this many USD.

Required range: x >= 0
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.

  • arpu_desc: average revenue per user, descending.
  • total_income_desc: total marketer income, descending.
  • income_today_desc: today's transactions sum, descending.
  • fans_desc: total subscribers, descending.
  • fans_today_desc: subscribers added since today's midnight UTC.
  • purchases_1_desc: fans who made at least one purchase, descending.
  • messages_3_desc: fans who exchanged at least 3 messages, descending.
Available options:
created_at_desc,
created_at_asc,
changed_at_desc,
changed_at_asc,
arpu_desc,
total_income_desc,
income_today_desc,
fans_desc,
fans_today_desc,
purchases_1_desc,
messages_3_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.