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
campaign_id
string

Filter to a single campaign by its public id.

Maximum string length: 32
creative_public_id
string

Only campaigns running the given creative.

Maximum string length: 32
of_account_id
integer

Only campaigns whose creative sits on this OnlyFans account.

Required range: x >= 1
status
enum<string>

Defaults to all statuses.

Available options:
active,
paused,
completed,
archived
sort
enum<string>
default:created_at_desc

Sort order.

  • created_at_desc: newest campaigns first (default).
  • created_at_asc: oldest campaigns first.
  • budget_desc: largest total budget first.
  • spend_desc: highest lifetime spend first.
  • clicks_desc: most unique clicks first.
  • impressions_desc: most impressions first.
Available options:
created_at_desc,
created_at_asc,
budget_desc,
spend_desc,
clicks_desc,
impressions_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.