Skip to main content
GET
Get the connection status

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 connection status, OnlyX's explanation, the next step and the sync progress.

checkedAt
string
required

When OnlyX checked this status (ISO-8601 UTC).

connected
boolean
required

true only when status is connected.

creatorId
string
required

The creator this status is for.

duplicateOfCreatorId
string | null
required

When status is duplicate: the creator in your workspace that already holds this OnlyFans account, if this credential can see it. Otherwise null.

message
string
required

OnlyX's own explanation of the current status, one or two sentences for a person.

nextStep
enum<string>
required

What to do now. send_connect_link: create a connect link and send it to her. wait: poll again in 10 seconds or more. complete_verification_in_app: open the creator in app.onlyx.ai. none: nothing to do. delete_and_readd: she signed in with a fan account; delete this creator in the dashboard, add her again and ask her to sign in with her creator account. use_duplicate: use the creator in duplicateOfCreatorId and delete this copy in the dashboard.

Available options:
send_connect_link,
wait,
complete_verification_in_app,
none,
delete_and_readd,
use_duplicate
status
enum<string>
required

disconnected: not signed in (send a connect link). connecting: the creator is signing in, or OnlyX is re-establishing the session. verification: OnlyFans asked for a human check; resolve it in app.onlyx.ai. connected: live. not_a_creator: a fan account signed in (final). duplicate: this OnlyFans account is already another creator in your workspace (final).

Available options:
disconnected,
connecting,
verification,
connected,
not_a_creator,
duplicate
sync
Sync · object
required

Progress of the sync that runs after she connects.

verificationRequired
boolean
required

true when OnlyFans wants a human check on the session (status is verification). Resolve it in app.onlyx.ai; the API reports it but cannot complete it.