Skip to main content
GET
List fans

Authorizations

Authorization
string
header
required

An API key (onx_sk_…) created in OnlyX under Settings → API & MCP, or an OAuth access token (onx_at_…) issued to a connected app. Send it as Authorization: Bearer <credential>. API keys may also be sent as X-API-Key: <key>.

Query Parameters

creatorId
string | null

Only this creator's fans.

Maximum string length: 40
q
string | null

Search by name (OnlyFans name or your custom name).

Maximum string length: 100
segment
enum<string> | null

A ready-made group of fans (see above).

Available options:
whales,
spenders,
never_spent,
new,
recent_buyer,
lapsing,
winback
status
enum<string> | null

active (subscribed now) or expired.

Available options:
active,
expired
sort
enum<string>
default:spend

Sort key. Default spend.

Available options:
spend,
subscribed,
last_active,
last_purchase,
name
order
enum<string> | null

Sort direction. Default desc, except asc for name.

Available options:
asc,
desc
limit
integer
default:25

Page size, 1-100. Default 25.

Required range: 1 <= x <= 100
cursor
string | null

Opaque cursor from the previous page's nextCursor. Omit for the first page.

Maximum string length: 1024

Response

A page of fans.

A page of fans: {data, hasMore, nextCursor}.

data
Fan · object[]
required
hasMore
boolean
required
nextCursor
string | null