Skip to main content
GET
Get a creator

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>.

Path Parameters

creatorId
string
required

The creator id (cre_…).

Response

The creator, with the readiness checks for the AI chatter.

aiEnabled
boolean
required

The creator's master AI switch. false means the AI chatter answers none of her fans.

avatarUrl
string | null
required

Her OnlyFans avatar, once connected.

connection
CreatorConnection · object
required

Headline connection state. GET /v1/creators/{creatorId}/connection has the detail.

true when OnlyFans is asking her to accept its content-consent prompt; media sends fail until she does it in OnlyFans. null when not known yet.

createdAt
string
required

When the creator was added to OnlyX (ISO-8601 UTC).

displayName
string
required

Your team's label for the creator. Set by you, never changed by OnlyFans.

handle
string | null
required

Her OnlyFans username, without @. Replaced by the real username once she connects.

id
string
required

The creator id (cre_…).

onlyfans
OnlyFansProfile · object | null
required

Profile facts read from OnlyFans. null until she has connected once.

platform
enum<string>
required

Always onlyfans for creators added through the API in v1. telegram is reserved for Telegram creators, which are coming soon, so code that reads this should expect more than one value.

Available options:
onlyfans,
telegram
publicName
string | null
required

The display name on her OnlyFans profile, once connected.

readiness
Readiness · object
required
stats
CreatorStats · object
required

Headline numbers, cheap to read.