# The Only API

> The Only API (theonlyapi.com) is a REST API and CRM for OnlyFans and Fansly:
> 529 endpoints across a signed OnlyFans `/api2/v2` passthrough and a
> normalized, Fansly-aware CRM layer. One API key, two platforms. Request
> signing, session persistence, proxy routing and re-login are handled
> server-side.

Base URL: `https://theonlyapi.com/api/crm/{crm_id}`
Auth: `X-API-Key` header on every request.

## Machine-readable bundles

- [Guides, full text](https://docs.theonlyapi.com/llms-guides.txt): Every concept and how-to guide. Start here.
- [CRM endpoint reference](https://docs.theonlyapi.com/llms-crm.txt): All 95 normalized endpoints (OnlyFans + Fansly).
- [OnlyFans passthrough reference](https://docs.theonlyapi.com/llms-of.txt): All 434 `/api2/v2` endpoints.
- [Everything](https://docs.theonlyapi.com/llms-full.txt): Guides plus the full reference. Large.
- [Agent brief](https://docs.theonlyapi.com/agents.md): Short operating brief for coding agents.
- [OpenAPI 3.1 spec](https://theonlyapi.com/api/openapi.json): The machine-readable contract this reference is generated from.
- [Docs MCP server](https://docs.theonlyapi.com/mcp): Search and read these docs over MCP (no auth).
- [API MCP server](https://theonlyapi.com/mcp): 59 tools that call the API (OAuth 2.1 or bearer API key).

Any page is available as Markdown by appending `.md` to its URL.

## Guides

- [Introduction](/docs): One API for OnlyFans and Fansly — 529 endpoints across a signed passthrough and a normalized CRM layer.
- [Use these docs with an AI](/docs/ai-agents): Copy any page as Markdown, open it in ChatGPT or Claude, or point an agent at an MCP server.
- [Async jobs](/docs/async-jobs): The 202-plus-poll pattern behind refresh, backfill and export.
- [Authentication](/docs/authentication): The X-API-Key header, panel scoping, and what each failure code means.
- [Automations](/docs/automations): Condition operators, payload templating, and the six action types.
- [Base URL & panels](/docs/base-url): Why every path carries a crm_id, and the seven routes that do not.
- [Bulk account import](/docs/bulk-import): Paste many accounts at once — preview, run, and answer 2FA prompts as they park.
- [Cached reads](/docs/cached-reads): The routes that cost zero platform requests, and how to keep them fresh.
- [Connect an account](/docs/connect-an-account): Session paste or credentials, 2FA, and the proxy requirement.
- [Earnings & transactions](/docs/earnings): Cross-account aggregation, the chargeback trap, and platform money scales.
- [Events](/docs/events): The event types, what triggers each, and their payload fields.
- [Data exports](/docs/exports): Export messages, tips, subscribers, fans and earnings as a ZIP.
- [FAQ](/docs/faq): Bans, proxies, quotas, Fansly support, and switching from another provider.
- [Get an API key](/docs/get-an-api-key): Where API keys live, primary vs secondary keys, and how to rotate one.
- [Integrations](/docs/integrations): Telegram notifications, account tags, and panel request metrics.
- [Messaging & mass DM](/docs/messaging): DMs, PPVs, mass sends with a dry-run preview, and the write-actions gate.
- [Pagination](/docs/pagination): Three conventions coexist. /chats ignores limit, and a short page is not the end.
- [OnlyFans & Fansly](/docs/platforms): Which surfaces support which platform, and what gets rejected.
- [Posting & scheduling](/docs/posting): Upload media, publish a post, or queue it for later — and the four ways this fails silently.
- [Proxies](/docs/proxies): Why OnlyFans needs one, what formats are accepted, and how to test one.
- [Quickstart](/docs/quickstart): From zero to a working integration — create a panel, connect an account, make your first call.
- [Rate limits & quotas](/docs/rate-limits): Per-minute HTTP limits, the monthly call quota, and the platform-side limits we do not enforce for you.
- [Responses & errors](/docs/responses): Two envelopes, the real error shapes, and one wrapper that will confuse you if you test without a key.
- [Sessions & re-login](/docs/sessions): How sessions persist, when we auto-retry, and what relogin_failed means.
- [Server-sent events](/docs/streaming): Subscribe to a live event stream over GET /events/stream.
- [Subscribers & fans](/docs/subscribers): Live vs cached reads, new-subscriber detection, tags and notes.
- [The two surfaces](/docs/two-surfaces): A thin signed passthrough and a normalized CRM layer, with different response shapes.
- [Webhooks](/docs/webhooks): Domain approval, signature verification, the retry ladder, and auto-deactivation.

## CRM API — normalized OnlyFans + Fansly

- [CRM API](/docs/crm): The normalized layer — 95 endpoints that work for both OnlyFans and Fansly.
- [Accounts](/docs/crm/accounts): Manage connected creator accounts (OnlyFans and Fansly), their polling settings, proxies, and slots.
- [Disconnect an account](/docs/crm/accounts/disconnect-an-account): Delete/disconnect a creator account from this CRM panel, freeing its slot. Works for OnlyFans and Fansly accounts. This is the only way to release a paid slot.
- [Get polling settings](/docs/crm/accounts/get-polling-settings): Read the background polling configuration for an account — whether polling is enabled, the interval, and whether write actions are allowed.
- [List connected accounts](/docs/crm/accounts/list-connected-accounts): Returns every creator account connected to this CRM panel — OnlyFans and Fansly. Each entry carries of_user_id, username, and platform ("onlyfans" or "fansly"). Use…
- [Read a Fansly account's stored session](/docs/crm/accounts/read-a-fansly-account-s-stored-session): Return the current Fansly session for one account you own, so an external worker can pick up refreshed tokens instead of holding a stale copy. We stay the credential…
- [Remove an account tag](/docs/crm/accounts/remove-an-account-tag): Remove a tag from a connected account. Pass the tag exactly as the API returned it — the stored form is escaped once on the way in, so re-escaping it here would look for a…
- [Tag a connected account](/docs/crm/accounts/tag-a-connected-account): Add a tag to a connected account, for grouping creators inside the panel. Tags are panel-local — they are never sent to the platform. Max 40 characters; re-adding an existing…
- [Update polling settings](/docs/crm/accounts/update-polling-settings): Enable/disable background polling for an account, set the interval, and control whether automations may perform write actions on the platform.
- [API Keys](/docs/crm/api-keys): Primary + secondary API key management. `POST /api-keys` and `DELETE /api-keys/{key_id}` are PRIMARY-KEY ONLY (a secondary key gets 403). The primary `Default` key cannot be revoked — rotate it via `POST /rotate-key`.
- [Create a secondary API key](/docs/crm/api-keys/create-a-secondary-api-key): Mint a new secondary API key. PRIMARY-KEY ONLY — calling this with a secondary key returns 403. The full key is returned exactly once, in this response, and is never…
- [List API keys](/docs/crm/api-keys/list-api-keys): List all API keys for the panel (active + revoked), each with this-month request count and a 30-day series. Full key bodies are never returned — only a prefix.
- [Per-key usage detail](/docs/crm/api-keys/per-key-usage-detail): 30/90-day usage series, month and all-time totals, last-used timestamp, and this month's endpoint breakdown for one key.
- [Revoke a secondary API key](/docs/crm/api-keys/revoke-a-secondary-api-key): Revoke a secondary key. PRIMARY-KEY ONLY — calling this with a secondary key returns 403. The primary Default key is non-revocable; rotate it via POST /rotate-key…
- [Rotate your API key](/docs/crm/api-keys/rotate-your-api-key): Rotate (regenerate) the caller's own API key. Authenticate with your current key. The old key dies immediately and the new key is returned once in the response body — store…
- [Auth](/docs/crm/auth): Connect a creator account (OnlyFans or Fansly) and complete 2FA. All three routes accept `platform: "onlyfans" | "fansly"` and are rate limited to 10 requests/minute.
- [Connect an account with an existing session (OnlyFans or Fansly)](/docs/crm/auth/connect-an-account-with-an-existing-session-onlyfans-or-fansly): Connect a creator account using credentials you already hold, rather than a password login.
- [Connect an account with credentials (OnlyFans or Fansly)](/docs/crm/auth/connect-an-account-with-credentials-onlyfans-or-fansly): Connect a new creator account via email/username + password. Set platform to "onlyfans" (default) or "fansly".
- [Verify 2FA OTP code (OnlyFans or Fansly)](/docs/crm/auth/verify-2fa-otp-code-onlyfans-or-fansly): Complete a 2FA login started by POST /accounts/login.
- [Automations](/docs/crm/automations): Event-triggered automations, manual runs, and run history.
- [Create an automation](/docs/crm/automations/create-an-automation): Run an action whenever a panel event fires. trigger_event must be a known event type (not ) and action_type must be a supported action. Rate limited to 120 requests/minute.
- [Delete an automation](/docs/crm/automations/delete-an-automation): Guide: [Automations](/docs/automations)
- [Get an automation](/docs/crm/automations/get-an-automation): Guide: [Automations](/docs/automations)
- [List automation runs](/docs/crm/automations/list-automation-runs): Execution history for one automation.
- [List automations](/docs/crm/automations/list-automations): Guide: [Automations](/docs/automations)
- [Run an automation immediately](/docs/crm/automations/run-an-automation-immediately): Guide: [Automations](/docs/automations)
- [Update an automation](/docs/crm/automations/update-an-automation): Guide: [Automations](/docs/automations)
- [Bulk Import](/docs/crm/bulk-import): Connect many creator accounts from one pasted list. `POST /import/preview` validates without side effects; `POST /import/jobs` runs the import in the background and streams `import.progress` / `import.complete` over `GET /events/stream`. Rows that hit a 2FA prompt park as `needs_2fa` until you supply a code.
- [Cancel an import job](/docs/crm/bulk-import/cancel-an-import-job): Stop an import. Cancellation is cooperative: pending rows are canceled at once and nothing further is claimed, but a row already mid-login runs to completion — we cannot…
- [Get an import job](/docs/crm/bulk-import/get-an-import-job): One job with its rows and counts. This is the fallback whenever an SSE event is missed — the stored row is authoritative, the events are only a live nudge.
- [List import jobs](/docs/crm/bulk-import/list-import-jobs): Import history for the panel, newest first, each job carrying its per-status row counts.
- [List rows waiting on a 2FA code](/docs/crm/bulk-import/list-rows-waiting-on-a-2fa-code): Every parked 2FA row on the panel, across all jobs — needs_2fa first, soonest to expire first.
- [Preview an import paste](/docs/crm/bulk-import/preview-an-import-paste): Parse and validate a pasted account list without side effects — nothing is written, no login is attempted, and no slot is consumed. Use it to show which rows are valid,…
- [Retry an import row](/docs/crm/bulk-import/retry-an-import-row): Re-queue one row and restart the job's worker. A needs_2fa_expired row re-runs the login from scratch — the parked challenge is dead, so replaying it would only earn…
- [Start a bulk import](/docs/crm/bulk-import/start-a-bulk-import): Create an import job and start working through the rows in the background. Returns 202 immediately with the job and its per-status counts.
- [Supply a 2FA code for an import row](/docs/crm/bulk-import/supply-a-2fa-code-for-an-import-row): Complete one row parked on needs_2fa by submitting the code the creator received.
- [Cache & Sync](/docs/crm/cache-and-sync): Async refresh, backfill, and job-status routes that populate the local cache. Refresh routes return 202 — poll the matching `/refresh/status` route or listen on `GET /events/stream`.
- [Backfill historical data (async)](/docs/crm/cache-and-sync/backfill-historical-data-async): Kick off a historical backfill for this account, walking further back than the routine refresh. Returns 202 — track progress via the refresh-status routes or GET…
- [Clear a stuck refresh job](/docs/crm/cache-and-sync/clear-a-stuck-refresh-job): Force a wedged refresh job to a terminal state so a new one can start.
- [List active refresh jobs](/docs/crm/cache-and-sync/list-active-refresh-jobs): All refresh/backfill jobs currently running across the panel. Zero platform requests.
- [Campaigns](/docs/crm/campaigns): Tracking link campaigns, claimers, campaign tags, and the tracked-campaign allowlist.
- [Add a tag to a campaign](/docs/crm/campaigns/add-a-tag-to-a-campaign): Guide: [Subscribers & fans](/docs/subscribers)
- [Campaign earnings breakdown](/docs/crm/campaigns/campaign-earnings-breakdown): Earnings attributed to each tracking-link campaign, computed from cached claimers joined with cached transactions. Zero platform requests.
- [Campaign refresh status](/docs/crm/campaigns/campaign-refresh-status): Progress/state of the current or last campaign refresh job. Zero platform requests.
- [Create campaign](/docs/crm/campaigns/create-campaign): Create a new tracking link campaign.
- [Get cached campaign claimers](/docs/crm/campaigns/get-cached-campaign-claimers): Cached claimers for one campaign, already joined with the subscriber cache so each row carries total_spent, its breakdown, and mapped_spent. Zero platform requests.
- [Get campaign claimers (live)](/docs/crm/campaigns/get-campaign-claimers-live): Fetch subscribers who converted through a specific campaign.
- [Get the tracked-campaign allowlist](/docs/crm/campaigns/get-the-tracked-campaign-allowlist): The allowlist of tracking-link campaigns (names/codes) kept synced for this account. When set, scheduled and backfill claimer syncs walk only these — so a huge link (20k+…
- [List campaign tags](/docs/crm/campaigns/list-campaign-tags): All campaign tags in use for this account.
- [List campaigns](/docs/crm/campaigns/list-campaigns): Get tracking link campaigns with statistics and pagination.
- [Refresh the campaign cache (async)](/docs/crm/campaigns/refresh-the-campaign-cache-async): Start an async campaign + claimer sync. Returns 202 — poll GET /accounts/{of_user_id}/campaigns/refresh/status or listen on GET /events/stream. Honours the…
- [Remove a tag from a campaign](/docs/crm/campaigns/remove-a-tag-from-a-campaign): Guide: [Subscribers & fans](/docs/subscribers)
- [Set the tracked-campaign allowlist](/docs/crm/campaigns/set-the-tracked-campaign-allowlist): Guide: [Subscribers & fans](/docs/subscribers)
- [Content](/docs/crm/content): Media upload. Runs OnlyFans' four-stage signed-S3 pipeline server-side and returns a reference you attach to a post, message or story via `mediaFiles`. OnlyFans only.
- [Upload media to the vault](/docs/crm/content/upload-media-to-the-vault): Upload a photo, video, gif or audio file to the account's vault, and get back a reference you can attach to a post, message or story.
- [Earnings](/docs/crm/earnings): Revenue & earnings data, including the cross-account `GET /earnings/summary` aggregation. Fansly-aware.
- [Aggregated earnings across all accounts](/docs/crm/earnings/aggregated-earnings-across-all-accounts): Server-side earnings aggregation across every account in the panel — OnlyFans and Fansly combined into one normalized response.
- [Get account balances](/docs/crm/earnings/get-account-balances): Fetch current payout balance for a connected account.
- [Get earnings chart data](/docs/crm/earnings/get-earnings-chart-data): Fetch earnings data for a date range with chart-ready breakdown.
- [Get panel-wide payout totals](/docs/crm/earnings/get-panel-wide-payout-totals): Available and pending payout totals across every connected account, in one query and zero platform calls.
- [Verify cached earnings against the platform](/docs/crm/earnings/verify-cached-earnings-against-the-platform): Cross-check one account's cached earnings against OnlyFans' own chart for the same window, and report both numbers plus the difference.
- [Events & Streaming](/docs/crm/events-and-streaming): Real-time event feed — `GET /events` for polling, `GET /events/stream` for Server-Sent Events (rate-limit exempt).
- [List events](/docs/crm/events-and-streaming/list-events): Poll the panel's event feed. Zero platform requests. Covers OnlyFans and Fansly accounts alike.
- [Stream events (SSE)](/docs/crm/events-and-streaming/stream-events-sse): Long-lived Server-Sent Events stream of panel events. Rate-limit exempt. Use this instead of polling to observe refresh-job completion and export.progress /…
- [Exports](/docs/crm/exports): Async data export jobs producing a downloadable ZIP. Progress streams over `GET /events/stream`.
- [Cancel a running export job](/docs/crm/exports/cancel-a-running-export-job): Guide: [Data exports](/docs/exports)
- [Create an export job](/docs/crm/exports/create-an-export-job): Kick off an async data export for one account. Returns 202 with the created job.
- [Delete an export job](/docs/crm/exports/delete-an-export-job): Delete the job and its generated ZIP.
- [Download an export ZIP](/docs/crm/exports/download-an-export-zip): Download the generated archive. Available until the retention window expires.
- [Get export job status](/docs/crm/exports/get-export-job-status): Guide: [Data exports](/docs/exports)
- [List export jobs](/docs/crm/exports/list-export-jobs): Guide: [Data exports](/docs/exports)
- [Fans](/docs/crm/fans): Fan CRM across all accounts in the panel — tags, notes, per-fan cached transactions, profile refresh. Fansly-aware.
- [Add a tag to a fan](/docs/crm/fans/add-a-tag-to-a-fan): Guide: [Subscribers & fans](/docs/subscribers)
- [Get a fan's cached transactions](/docs/crm/fans/get-a-fan-s-cached-transactions): Every cached transaction attributed to one fan on this account. Zero platform requests. Fansly-aware.
- [List fans](/docs/crm/fans/list-fans): Fan CRM across the whole panel — every fan seen on any connected account, OnlyFans or Fansly, with tags, notes, spend, and activity counters. Zero platform requests.
- [Refresh a fan profile from the platform](/docs/crm/fans/refresh-a-fan-profile-from-the-platform): Re-fetch one fan's profile from the platform and update the cache. Consumes a platform request.
- [Remove a tag from a fan](/docs/crm/fans/remove-a-tag-from-a-fan): Guide: [Subscribers & fans](/docs/subscribers)
- [Set a fan note](/docs/crm/fans/set-a-fan-note): Replace the free-text CRM note stored against a fan. Send an empty string to clear it.
- [Integrations](/docs/crm/integrations): Third-party integrations. One Telegram channel per panel: pair it once, then matching events are delivered to that chat. The bot token is encrypted at rest and is never returned by any route.
- [Get the Telegram integration](/docs/crm/integrations/get-the-telegram-integration): The panel's Telegram channel, or integration: null if none is configured.
- [Register Telegram groups](/docs/crm/integrations/register-telegram-groups): Register Telegram group targets so automations and webhooks can deliver notifications there.
- [Remove the Telegram integration](/docs/crm/integrations/remove-the-telegram-integration): Unpair the channel and delete the stored configuration, including any custom bot token.
- [Send a Telegram test message](/docs/crm/integrations/send-a-telegram-test-message): Post a test message to the paired chat, so you can confirm the whole path end to end. Returns 400 with the failure reason — and the current integration state, including…
- [Start Telegram pairing](/docs/crm/integrations/start-telegram-pairing): Begin (or restart) pairing and get a t.me deep link. Open the link, and the chat that the bot lands in becomes the panel's channel.
- [Update the Telegram integration](/docs/crm/integrations/update-the-telegram-integration): Change which events are delivered, or pause delivery without unpairing. Send only the fields you want to change.
- [MCP](/docs/crm/mcp): Hosted MCP server support. `GET /api/whoami` turns a bearer token into a tenant; `PATCH /mcp/unsafe-proxy` toggles non-GET tool access (off by default).
- [Toggle MCP non-GET proxy access](/docs/crm/mcp/toggle-mcp-non-get-proxy-access): Toggle whether the hosted MCP server may issue non-GET requests through the generic OF proxy tool. Off by default. Use with care: enabling it lets a model POST/PATCH/DELETE…
- [Messaging](/docs/crm/messaging): Chats, single DMs/PPVs, mass DMs, and PPV performance stats. Fansly-aware.
- [Get message history](/docs/crm/messaging/get-message-history): Message history for one conversation, newest-first by default. Fansly-aware.
- [List chats](/docs/crm/messaging/list-chats): Conversation list for a connected account. Fansly-aware.
- [PPV performance stats](/docs/crm/messaging/ppv-performance-stats): Purchase/unlock statistics for PPV messages sent from this account, computed from cached transactions. Zero platform requests. Fansly-aware.
- [Send a DM or PPV](/docs/crm/messaging/send-a-dm-or-ppv): Send a single DM (or PPV) to one fan. Works for OnlyFans and Fansly.
- [Send a mass DM](/docs/crm/messaging/send-a-mass-dm): Send one message to many fans at once. Supports PPV pricing and vault media, and can target a subscriber segment. Rate limited to 120 requests/minute. Fansly-aware.
- [Notifications](/docs/crm/notifications): Account notifications. Fansly-aware.
- [Get notifications](/docs/crm/notifications/get-notifications): Fetch notifications for a connected account.
- [Panel & Usage](/docs/crm/panel-and-usage): Panel signup, health, key→panel resolution, and plan/usage counters. Works for OnlyFans and Fansly panels alike.
- [Create a CRM panel](/docs/crm/panel-and-usage/create-a-crm-panel): Create a CRM panel and receive its crm_id plus the primary Default API key. The key is returned once — store it.
- [Dashboard user login](/docs/crm/panel-and-usage/dashboard-user-login): Authenticate a dashboard user. Rate limited to 6 requests/minute — the strictest limit in the API.
- [Get plan usage](/docs/crm/panel-and-usage/get-plan-usage): Current plan and consumption for this panel.
- [Get request metrics for your panel](/docs/crm/panel-and-usage/get-request-metrics-for-your-panel): Request outcomes for your own panel over a time window: volume, status classes, error rate, latency, and the slowest and most error-prone routes. This is what the dashboard…
- [Register a dashboard user](/docs/crm/panel-and-usage/register-a-dashboard-user): Create a dashboard account. This also creates your CRM panel and returns its crm_id and primary api_key in the same response — there is no second step. Do not follow…
- [Resolve an API key to a panel](/docs/crm/panel-and-usage/resolve-an-api-key-to-a-panel): Resolves the API key sent in X-API-Key to its crm_id. This is how the hosted MCP server turns a bearer token into a tenant. Returns only public-safe fields (panel id, plan…
- [Send an email verification code](/docs/crm/panel-and-usage/send-an-email-verification-code): Guide: [Base URL & panels](/docs/base-url)
- [Service health check](/docs/crm/panel-and-usage/service-health-check): Liveness probe. Exempt from rate limiting and requires no API key.
- [Verify an email code](/docs/crm/panel-and-usage/verify-an-email-code): Guide: [Base URL & panels](/docs/base-url)
- [Payouts](/docs/crm/payouts): Withdrawal requests and payout account details. Creating a withdrawal is OnlyFans only.
- [Create payout request](/docs/crm/payouts/create-payout-request): Create a withdrawal request for a connected account.
- [Get payout account](/docs/crm/payouts/get-payout-account): Payout/withdrawal account details for a connected account.
- [List withdrawal requests](/docs/crm/payouts/list-withdrawal-requests): Withdrawal request history for the account. For OnlyFans this is read live from the platform; for Fansly it is served from the synced wallet ledger.
- [Proxy](/docs/crm/proxy): Generic authenticated OnlyFans API proxy (`POST /accounts/{of_user_id}/request`). OnlyFans only.
- [Generic OF API proxy](/docs/crm/proxy/generic-of-api-proxy): Send any authenticated request to the OnlyFans API. Use this to access any OF endpoint not covered by the dedicated CRM routes. Auto-relogins on session expiry.
- [Referrals](/docs/crm/referrals): OnlyFans referral programme — who the account referred, what it earned, and referral payout history. **OnlyFans only**: Fansly accounts get `501 platform_not_supported` (`feature: "referrals"`). Live reads, no cache; one quota call per request. OnlyFans' referral response bodies are passed through with minimal normalization — only the `list`/`hasMore`/`marker` envelope keys are read, and the raw body is echoed under `data`. Fields *inside* a referral row are unverified: do not depend on them without checking against a live account.
- [List referral payout requests](/docs/crm/referrals/list-referral-payout-requests): Referral payout history — the referral twin of GET /accounts/{of_user_id}/payout-requests, shaped identically.
- [List referred users](/docs/crm/referrals/list-referred-users): The creators/users this account referred, read live from OnlyFans.
- [Referral balance + chart](/docs/crm/referrals/referral-balance-chart): Referral money summary in one response, fanned out to two OnlyFans endpoints (still one quota call).
- [Settings](/docs/crm/settings): Account settings, subscription price & proxy management
- [Get account proxy](/docs/crm/settings/get-account-proxy): Get the current proxy configured for an account.
- [Get subscription price](/docs/crm/settings/get-subscription-price): Read the account's current subscription price live from /users/me. Consumes a platform request.
- [Test a proxy](/docs/crm/settings/test-a-proxy): Check that a proxy URL is reachable and usable before connecting an account with it. HTTP and SOCKS5 are both accepted.
- [Update account proxy](/docs/crm/settings/update-account-proxy): Update or remove the proxy for an account. Set to null to remove.
- [Update subscription price](/docs/crm/settings/update-subscription-price): Change the subscription price for a connected OnlyFans account.
- [Subscribers](/docs/crm/subscribers): Subscriber reads. Live routes hit the platform; `/subscribers/cached`, `/subscribers/new`, and `/subscribers/stats` cost zero platform requests and normalize OnlyFans + Fansly rows to the same shape.
- [List cached subscribers](/docs/crm/subscribers/list-cached-subscribers): Read subscribers from the local cache, populated by the background refresh job. Zero platform requests.
- [List newly-seen subscribers](/docs/crm/subscribers/list-newly-seen-subscribers): Subscribers first seen within a recent window, read from the cache. Zero platform requests. Fansly-aware.
- [List subscribers](/docs/crm/subscribers/list-subscribers): Get subscribers with pagination and type filtering. Includes total spent data.
- [Refresh the subscriber cache (async)](/docs/crm/subscribers/refresh-the-subscriber-cache-async): Start an async subscriber sync for this account. Returns 202 immediately — poll GET /accounts/{of_user_id}/subscribers/refresh/status or listen on GET /events/stream…
- [Subscriber refresh status](/docs/crm/subscribers/subscriber-refresh-status): Progress/state of the current or last subscriber refresh job. Zero platform requests.
- [Subscriber statistics](/docs/crm/subscribers/subscriber-statistics): Time-bucketed counts of incoming subscriptions, plus the cache summary. Zero platform requests. Fansly-aware.
- [Transactions](/docs/crm/transactions): Payout & purchase transactions, live and cached.
- [Get purchase transactions](/docs/crm/transactions/get-purchase-transactions): Fetch payout transactions with marker-based pagination.
- [List cached transactions](/docs/crm/transactions/list-cached-transactions): Read transactions from the local cache. Zero platform requests. OnlyFans and Fansly rows are normalized to the same shape.
- [Refresh the transaction cache (async)](/docs/crm/transactions/refresh-the-transaction-cache-async): Start an async transaction sync. Returns 202 — poll GET /accounts/{of_user_id}/transactions/refresh/status or listen on GET /events/stream. Works for OnlyFans and Fansly.
- [Transaction refresh status](/docs/crm/transactions/transaction-refresh-status): Progress/state of the current or last transaction refresh job. Zero platform requests.
- [Webhooks](/docs/crm/webhooks): Outbound webhook subscriptions, test fires, and delivery history.
- [Create a webhook](/docs/crm/webhooks/create-a-webhook): Subscribe an HTTPS endpoint to panel events. Rate limited to 120 requests/minute.
- [Delete a webhook](/docs/crm/webhooks/delete-a-webhook): Guide: [Webhooks](/docs/webhooks)
- [Get a webhook](/docs/crm/webhooks/get-a-webhook): Guide: [Webhooks](/docs/webhooks)
- [List webhook deliveries](/docs/crm/webhooks/list-webhook-deliveries): Delivery history with response status codes, for debugging failures.
- [List webhooks](/docs/crm/webhooks/list-webhooks): Guide: [Webhooks](/docs/webhooks)
- [Send a test delivery](/docs/crm/webhooks/send-a-test-delivery): Fire a synthetic event at the webhook so you can verify the endpoint and signature handling. The delivery carries X-OnlyAPI-Signature (sha256=<hex digest>),…
- [Update a webhook](/docs/crm/webhooks/update-a-webhook): Guide: [Webhooks](/docs/webhooks)

## OnlyFans passthrough — /api2/v2, OnlyFans only

- [OnlyFans Passthrough](/docs/of-api): 434 endpoints proxied straight through to OnlyFans, signed for you. OnlyFans only.
- [Campaigns](/docs/of-api/campaigns): OnlyFans campaign endpoints (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Create campaign](/docs/of-api/campaigns/create-campaign-post): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get campaign conversions](/docs/of-api/campaigns/get-campaign-conversions): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [List campaigns](/docs/of-api/campaigns/list-campaigns-get): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Content](/docs/of-api/content): OnlyFans posts, vault, labels (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Add media to vault list](/docs/of-api/content/add-media-to-vault-list): Add one or more media items to a vault list (folder) for organization.
- [Add post to bookmark category](/docs/of-api/content/add-post-to-bookmark-category): Adds a post to a bookmark category. Called as ({categoryId, postId}). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add post to favorites](/docs/of-api/content/add-post-to-favorites): Marks the given post (by the specified author) as a favorite for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Attach release form](/docs/of-api/content/attach-release-form): Attaches a release form (content consent document) to content. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Attach vault media to post/message](/docs/of-api/content/attach-vault-media-to-post-message): Attach a media item from the vault to an existing post or message. The media must already be uploaded.
- [Bookmark a post](/docs/of-api/content/bookmark-a-post): Adds a post to bookmarks; an optional chat_group_id body targets a specific bookmark group. DELETE on the same path removes the bookmark. OnlyFans only — Fansly accounts…
- [Count fundraising contributors](/docs/of-api/content/count-fundraising-contributors): Returns the number of contributors to a post's fundraising campaign. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Create a new post](/docs/of-api/content/create-a-new-post): Create a new post on your profile. Supports text, media attachments, PPV pricing, polls, scheduled publishing (isScheduled + scheduledDate), and expiration dates.
- [Create release form link](/docs/of-api/content/create-release-form-link): Creates a release-form link (content consent document link) from the supplied data. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Create signed media upload](/docs/of-api/content/create-signed-media-upload): Stage 1 of OnlyFans' media upload. Returns pre-signed S3 URL(s) that you then PUT the bytes to.
- [Delete a bookmark category](/docs/of-api/content/delete-a-bookmark-category): Deletes a post-bookmark category by id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete a comment](/docs/of-api/content/delete-a-comment): Deletes a specific comment by its id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete vault list](/docs/of-api/content/delete-vault-list): Deletes a vault media list, optionally also clearing its media. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Find vault media by MD5 (dedupe)](/docs/of-api/content/find-vault-media-by-md5-dedupe): Deduplication / file→vault-item lookup. Given the MD5 of an original file, returns the matching vault media if that exact byte content was previously uploaded, or 404…
- [Finish signed upload](/docs/of-api/content/finish-signed-upload): Stage 3 of OnlyFans' media upload — completes an S3 multipart upload after every part has been PUT.
- [Get bookmark categories](/docs/of-api/content/get-bookmark-categories): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get bookmarked posts](/docs/of-api/content/get-bookmarked-posts): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get DRM certificate](/docs/of-api/content/get-drm-certificate): Retrieves the DRM certificate used for protected media playback. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get 'on this day' posts](/docs/of-api/content/get-on-this-day-posts): Retrieves the current user's posts from this date in previous years ('on this day' memories). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get post comments](/docs/of-api/content/get-post-comments): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get posts feed](/docs/of-api/content/get-posts-feed): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get posts using a vault media item](/docs/of-api/content/get-posts-using-a-vault-media-item): List posts that use a specific vault media item.
- [Get scheduled-post counts per day](/docs/of-api/content/get-scheduled-post-counts-per-day): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get scheduled posts](/docs/of-api/content/get-scheduled-posts): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get specific post](/docs/of-api/content/get-specific-post): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get user labels](/docs/of-api/content/get-user-labels): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get vault lists (folders)](/docs/of-api/content/get-vault-lists-folders): List the vault folders for an account.
- [Get vault media](/docs/of-api/content/get-vault-media): List vault media items. This is how you obtain the integer media IDs referenced by post creation, story creation, and messages.
- [Get vault media being processed](/docs/of-api/content/get-vault-media-being-processed): List media still being processed/transcoded by OnlyFans (items whose isReady is false).
- [Get vault media item](/docs/of-api/content/get-vault-media-item): Get a single vault media item by ID.
- [Get vault media list](/docs/of-api/content/get-vault-media-list): Retrieves a single vault media list by id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get vault media release forms](/docs/of-api/content/get-vault-media-release-forms): Returns the release forms attached to a vault media item identified by media_id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get vault media types present](/docs/of-api/content/get-vault-media-types-present): Report which media types exist in the vault. data is a flat object of booleans (NOT counts) — one per type.
- [Hide a post](/docs/of-api/content/hide-a-post): Hides the specified post. Defined alongside post pin, favorite, vote and delete calls. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Hide vault media](/docs/of-api/content/hide-vault-media): Marks the given vault media items as hidden. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Like a comment](/docs/of-api/content/like-a-comment): Adds a like to the specified comment. Paired with a DELETE on the same path to unlike, plus comment pin/delete calls. OnlyFans only — Fansly accounts are rejected on…
- [Like / favorite a post](/docs/of-api/content/like-favorite-a-post): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Pin a comment](/docs/of-api/content/pin-a-comment): Pins the specified comment. Paired with a DELETE on the same path to unpin. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Publish a scheduled item](/docs/of-api/content/publish-a-scheduled-item): Publishes a scheduled entity (e.g. queued post/stream) immediately by its schedule id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Remove post from bookmarks](/docs/of-api/content/remove-post-from-bookmarks): Removes the given post from the user's bookmarks; an optional chat_group_id can scope the removal to a specific bookmark group. OnlyFans only — Fansly accounts are rejected…
- [Rename a vault list](/docs/of-api/content/rename-a-vault-list): Renames a media vault list identified by list id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Rename bookmark category](/docs/of-api/content/rename-bookmark-category): Renames a post-bookmark category (DELETE removes it, POST creates one). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Reorder pinned posts](/docs/of-api/content/reorder-pinned-posts): Change the display order of your pinned posts on your profile.
- [Report post view/interaction stats](/docs/of-api/content/report-post-view-interaction-stats): Submit post view and interaction analytics. Used by the client to report which posts were viewed, scrolled past, or interacted with.
- [Sort bookmark categories](/docs/of-api/content/sort-bookmark-categories): Sets the sort order of post bookmark categories. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Sort pinned paid posts](/docs/of-api/content/sort-pinned-paid-posts): Reorders the creator's pinned paid posts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Sort vault lists](/docs/of-api/content/sort-vault-lists): Reorders the creator's vault media lists. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Unlike a comment](/docs/of-api/content/unlike-a-comment): Removes the current user's like from a comment (POST on the same path adds a like). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Unpin a comment](/docs/of-api/content/unpin-a-comment): Removes the pinned status from a comment. The paired POST /comments/{id}/pin pins it. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Vote on a post poll](/docs/of-api/content/vote-on-a-post-poll): Submit a vote on a post that has a poll attached. Get the optionId from the post's voting array.
- [Helpers](/docs/of-api/helpers): OnlyFans helper/manager accounts (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Get helper permissions](/docs/of-api/helpers/get-helper-permissions): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [List account helpers](/docs/of-api/helpers/list-account-helpers): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Lists](/docs/of-api/lists): OnlyFans user lists (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Add award-winning users to list](/docs/of-api/lists/add-award-winning-users-to-list): Adds users who received awards in the given year/month to the specified list. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add campaign claimers to list](/docs/of-api/lists/add-campaign-claimers-to-list): Adds the users who claimed a campaign to a custom list. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add claimers to list](/docs/of-api/lists/add-claimers-to-list): Adds users who claimed a given entity (identified by type and id) to the specified list. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add media buyers to list](/docs/of-api/lists/add-media-buyers-to-list): Adds users who purchased a given media item to a list (bulk add by media). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add posts to label](/docs/of-api/lists/add-posts-to-label): Adds one or more posts to a label. Called as (labelId, posts[]). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add queue buyers to list](/docs/of-api/lists/add-queue-buyers-to-list): Adds users who bought from a given queue to a list (bulk add by queue). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add story viewers to list](/docs/of-api/lists/add-story-viewers-to-list): Adds users who interacted with a given story (by interaction type) to the specified list. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add stream audience to list](/docs/of-api/lists/add-stream-audience-to-list): Adds users from a live stream (matching the given type/criteria) to a list, optionally filtered by tip/subscription thresholds. OnlyFans only — Fansly accounts are rejected…
- [Add subscribers to list](/docs/of-api/lists/add-subscribers-to-list): Adds subscribers to the list identified by list_id. Enclosing fn is addSubscribersToList. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add top subscribers to list](/docs/of-api/lists/add-top-subscribers-to-list): Adds the account's top subscribers to the given list (addTopSubscribersToList). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add user to list](/docs/of-api/lists/add-user-to-list): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Add users to lists](/docs/of-api/lists/add-users-to-lists): Adds users to one or more lists in bulk. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Check list membership](/docs/of-api/lists/check-list-membership): Checks whether a given user belongs to a specific list. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Create a new list](/docs/of-api/lists/create-a-new-list): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Delete a label](/docs/of-api/lists/delete-a-label): Deletes a label identified by label id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete a list](/docs/of-api/lists/delete-a-list): Deletes a user list by id (GET retrieves it, PATCH renames/updates it). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get a label by ID](/docs/of-api/lists/get-a-label-by-id): Retrieves a single content label by its ID. Sibling calls create, rename, sort and delete labels. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get a user list](/docs/of-api/lists/get-a-user-list): Retrieves a single user list identified by list_id. Enclosing fn is getUsersList. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get user lists](/docs/of-api/lists/get-user-lists): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get users in a list](/docs/of-api/lists/get-users-in-a-list): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Pin user in list](/docs/of-api/lists/pin-user-in-list): Pins a user to the top of a custom list. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Remove all posts from label](/docs/of-api/lists/remove-all-posts-from-label): Removes all posts from the specified label. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Remove post from label](/docs/of-api/lists/remove-post-from-label): Removes a single post from the specified label. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Remove stream users from list](/docs/of-api/lists/remove-stream-users-from-list): Removes stream-derived users (e.g. viewers who tipped or subscribed over a threshold) of a given type from a list. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Remove user from list](/docs/of-api/lists/remove-user-from-list): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Rename a label](/docs/of-api/lists/rename-a-label): Renames the label identified by label_id to the provided name. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Sort labels](/docs/of-api/lists/sort-labels): Reorders the user's labels according to the supplied order. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Sort pinned list users](/docs/of-api/lists/sort-pinned-list-users): Reorders the pinned users within a list identified by list_id, per the provided order. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Sort user lists](/docs/of-api/lists/sort-user-lists): Persists a new ordering of the user's lists. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Sort users in list](/docs/of-api/lists/sort-users-in-list): Sorts the users within a list. Called as sortListUsers({listId, data}). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update a list](/docs/of-api/lists/update-a-list): Updates the given user list (getUsersList/updateList module). Sibling calls create, delete and sort lists. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Messaging](/docs/of-api/messaging): OnlyFans chats & messages (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Calculate mass message audience size](/docs/of-api/messaging/calculate-mass-message-audience-size): Preview how many users would receive a mass message given the buyer filter criteria.
- [Create a mass message](/docs/of-api/messaging/create-a-mass-message): Queue a mass message to be sent to multiple subscribers. You can target all subscribers, specific lists, or exclude certain users.
- [Delete message template](/docs/of-api/messaging/delete-message-template): Deletes a saved message template. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete queued message](/docs/of-api/messaging/delete-queued-message): Deletes a queued (scheduled) mass message by its queue ID. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get chat messages](/docs/of-api/messaging/get-chat-messages): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get message templates](/docs/of-api/messaging/get-message-templates): Get saved message templates for quick replies.
- [Get queued mass messages](/docs/of-api/messaging/get-queued-mass-messages): List all scheduled/queued mass messages. These are messages waiting to be sent to multiple users.
- [Get single chat message](/docs/of-api/messaging/get-single-chat-message): Retrieves a specific message within the chat with a given user. Called as getMessage({userId, groupId}). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Hide a message](/docs/of-api/messaging/hide-a-message): Hides a chat message identified by message_id. The request body carries hide options. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Like / react to a message](/docs/of-api/messaging/like-react-to-a-message): Send a like reaction to a specific message in a chat.
- [List recent chats](/docs/of-api/messaging/list-recent-chats): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Mark chat as read](/docs/of-api/messaging/mark-chat-as-read): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Mark chats as read](/docs/of-api/messaging/mark-chats-as-read): Marks one or more chats as read for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Search messages in chat](/docs/of-api/messaging/search-messages-in-chat): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Send a message](/docs/of-api/messaging/send-a-message): Send a direct message to a user. Supports text, media attachments (uploaded via the media upload endpoint first), PPV pricing, and locked text. Media must be uploaded to the…
- [Set reply-on-subscribe template](/docs/of-api/messaging/set-reply-on-subscribe-template): Creates or updates the automatic welcome message template sent when a fan subscribes. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update queued message](/docs/of-api/messaging/update-queued-message): Updates a queued/scheduled message identified by its queue id with new message data. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Misc](/docs/of-api/misc): Other OnlyFans endpoints. **OnlyFans only** — Fansly accounts are rejected on this surface.
- [App initialization data](/docs/of-api/misc/app-initialization-data): Returns comprehensive initialization data including authenticated user profile, feature flags, chat counts, and app configuration.
- [Assign a guest](/docs/of-api/misc/assign-a-guest): Assigns a guest (co-performer/guest record) identified by guest_id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Change legal inquiry status](/docs/of-api/misc/change-legal-inquiry-status): Changes the status of a legal inquiry. Part of the legal-inquiry (static-law) module. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Check support ticket allowed](/docs/of-api/misc/check-support-ticket-allowed): Checks whether the user is allowed to create a support ticket (part of the users/tickets support module). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Confirm terms acceptance](/docs/of-api/misc/confirm-terms-acceptance): Confirms the user's acceptance of updated terms. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Create a support ticket](/docs/of-api/misc/create-a-support-ticket): Creates a new support ticket for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete Shopify store](/docs/of-api/misc/delete-shopify-store): Disconnects/removes a linked Shopify store by ID. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Expand address for country](/docs/of-api/misc/expand-address-for-country): Expands/resolves a partial address (by its hash) for a given country, optionally in Latin transliteration. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Generate release form link URL](/docs/of-api/misc/generate-release-form-link-url): Generates/returns a shareable URL for a release form link identified by link_id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get client IP address](/docs/of-api/misc/get-client-ip-address): Returns the caller's IP address as seen by the API. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get guest details](/docs/of-api/misc/get-guest-details): Retrieves a guest record by id. Guests appear alongside release-form and guest-assign endpoints (people tagged in content). OnlyFans only — Fansly accounts are rejected on…
- [Get latest subscribers](/docs/of-api/misc/get-latest-subscribers): Returns the latest subscribers within a date range, grouped by the given field. The dynamic path segment is actually the querystring. OnlyFans only — Fansly accounts are…
- [Get legal inquiry](/docs/of-api/misc/get-legal-inquiry): Retrieves a legal inquiry (e.g. legal/DMCA request) by ID. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get legal inquiry form params](/docs/of-api/misc/get-legal-inquiry-form-params): Returns the parameter/option definitions used to build the legal inquiry form. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get legal inquiry history](/docs/of-api/misc/get-legal-inquiry-history): Returns the history/audit trail for a legal inquiry by id (from the legal/law module). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get legal inquiry update](/docs/of-api/misc/get-legal-inquiry-update): Retrieves a specific update of a legal inquiry identified by inquiry_id, addressed by an update hash. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get messages earnings chart](/docs/of-api/misc/get-messages-earnings-chart): Returns time-series earnings/statistics for queued messages. The dynamic path segment is a built querystring. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get messages statistics by type](/docs/of-api/misc/get-messages-statistics-by-type): Returns the current user's messaging statistics for a given type (default 'all') over a date range, paginated and searchable. OnlyFans only — Fansly accounts are rejected…
- [Get partner release forms](/docs/of-api/misc/get-partner-release-forms): Retrieves release forms associated with a partner identified by partner id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get payouts chart stats](/docs/of-api/misc/get-payouts-chart-stats): Returns payouts chart statistics (amount/count) over a date range. The dynamic path segment is the serialized querystring. OnlyFans only — Fansly accounts are rejected on…
- [Get posts earnings chart](/docs/of-api/misc/get-posts-earnings-chart): Returns time-series earnings/statistics for posts. The dynamic path segment is a built querystring, not an id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get promotions statistics chart](/docs/of-api/misc/get-promotions-statistics-chart): Returns chart/statistics data for promotions over a date range. Path segment is static; the trailing token is a serialized query string. OnlyFans only — Fansly accounts are…
- [Get report reason detail options](/docs/of-api/misc/get-report-reason-detail-options): Retrieves the detail options available for a specific report reason. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get state for a ZIP code](/docs/of-api/misc/get-state-for-a-zip-code): Looks up the state/region associated with a given ZIP code, used by payouts address forms. Defined in the payouts/address module. OnlyFans only — Fansly accounts are…
- [Get stories statistics chart](/docs/of-api/misc/get-stories-statistics-chart): Returns time-series chart data for stories earnings/activity over a date range. The {id} in path_raw is actually the querystring appended by the Zq helper. OnlyFans only…
- [Get streaks over date range](/docs/of-api/misc/get-streaks-over-date-range): Retrieves subscriber/engagement streak statistics over a date range. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get streams stats chart](/docs/of-api/misc/get-streams-stats-chart): Returns time-series chart data for live-stream statistics over a date range. The dynamic path segment is actually the querystring. OnlyFans only — Fansly accounts are…
- [Get subscribers statistics chart](/docs/of-api/misc/get-subscribers-statistics-chart): Returns chart/statistics data for subscribers over a date range, groupable via 'by'. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get support ticket](/docs/of-api/misc/get-support-ticket): Retrieves a support ticket by id. Grouped with ticket reply/comments/solve/reopen endpoints. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get support ticket subjects](/docs/of-api/misc/get-support-ticket-subjects): Returns the selectable subject options for the support-ticket creation form. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get top fans stats](/docs/of-api/misc/get-top-fans-stats): Returns the current user's top-fan statistics over a date range. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get top messages stats](/docs/of-api/misc/get-top-messages-stats): Returns statistics on the current user's top-performing messages over a date range. The {id} in path_raw is the appended querystring. OnlyFans only — Fansly accounts are…
- [Get top posts statistics](/docs/of-api/misc/get-top-posts-statistics): Returns the current user's top-performing posts statistics for a date range. Sibling calls fetch top story/stream/stream stats. OnlyFans only — Fansly accounts are rejected…
- [Get top posts stats](/docs/of-api/misc/get-top-posts-stats): Returns top-performing posts statistics over a date range. The dynamic path segment is the serialized querystring. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get top stories stats](/docs/of-api/misc/get-top-stories-stats): Returns top-performing stories statistics for a date range, optionally grouped. The dynamic suffix in path_raw is the querystring. OnlyFans only — Fansly accounts are…
- [Get top stories stats](/docs/of-api/misc/get-top-stories-stats-get): Retrieves top-performing story statistics over a date range. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get top streaks](/docs/of-api/misc/get-top-streaks): Returns the top fan streaks for the creator. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get top streams stats](/docs/of-api/misc/get-top-streams-stats): Returns top-performing live streams over a date range, ranked (default by purchases) with pagination. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get top streams stats](/docs/of-api/misc/get-top-streams-stats-get): Returns the current user's top-performing streams statistics for a date range. The dynamic suffix in path_raw is the querystring. OnlyFans only — Fansly accounts are…
- [Get top subscribers stats](/docs/of-api/misc/get-top-subscribers-stats): Retrieves top subscribers over a date range (statistics context). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get trial link statistics](/docs/of-api/misc/get-trial-link-statistics): Returns statistics for free-trial links over a date range with pagination. The dynamic suffix in path_raw is the querystring. OnlyFans only — Fansly accounts are rejected…
- [Get trials chart stats](/docs/of-api/misc/get-trials-chart-stats): Returns trial statistics chart data over a date range. The dynamic path segment is the serialized querystring, not a path param. OnlyFans only — Fansly accounts are…
- [Get VAT payouts chart stats](/docs/of-api/misc/get-vat-payouts-chart-stats): Returns VAT payouts chart statistics (amount/count) over a date range. The dynamic path segment is the serialized querystring. OnlyFans only — Fansly accounts are rejected…
- [List content report reasons](/docs/of-api/misc/list-content-report-reasons): Returns the list of available reasons for reporting content or users. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List referrals](/docs/of-api/misc/list-referrals): Returns the current user's referrals over a date range with pagination. The dynamic path segment is a built querystring. OnlyFans only — Fansly accounts are rejected on…
- [List states for a country](/docs/of-api/misc/list-states-for-a-country): Returns the list of states/regions for the specified country. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List states for country](/docs/of-api/misc/list-states-for-country): Returns the ISO list of states/regions for a given country. Reference/lookup data. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Mark support ticket as read](/docs/of-api/misc/mark-support-ticket-as-read): Marks the given support ticket as read. Part of the users/tickets support module (reply, solve, reopen, comments). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Mark support ticket solved](/docs/of-api/misc/mark-support-ticket-solved): Marks a user support ticket as solved. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Record address statistics](/docs/of-api/misc/record-address-statistics): Posts address-related statistics data. Appears alongside GDPR, clicks-stats and accepted-cookies analytics calls. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Rename a release form](/docs/of-api/misc/rename-a-release-form): Renames a content release form. Part of the release-forms module (attach, links, documents, toggle-show). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Reopen a support ticket](/docs/of-api/misc/reopen-a-support-ticket): Reopens a previously closed support ticket identified by ticket_id. Body carries the reopen data. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Reply to support ticket](/docs/of-api/misc/reply-to-support-ticket): Posts a reply to the specified support ticket. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Report user click statistics](/docs/of-api/misc/report-user-click-statistics): Sends a batch of user click/interaction statistics for tracking. The response is fire-and-forget (errors are swallowed via .catch). OnlyFans only — Fansly accounts are…
- [Search localization texts](/docs/of-api/misc/search-localization-texts): Searches localization strings by code and languages. Part of the i18n text system (texts.onlyfans.com). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Send legal inquiry notification](/docs/of-api/misc/send-legal-inquiry-notification): Sends a notification for the specified legal inquiry. No request body is sent. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Start release form link](/docs/of-api/misc/start-release-form-link): Starts the flow for a release-form (consent) link identified by its id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit a legal inquiry](/docs/of-api/misc/submit-a-legal-inquiry): Creates/submits a new legal inquiry (takedown/legal request). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit client-side log entry](/docs/of-api/misc/submit-client-side-log-entry): Sends a client log message with optional context data, logger name and level to the server-side logging endpoint. The context is wrapped with an onlyfans.<logger> logger name…
- [Submit consent form](/docs/of-api/misc/submit-consent-form): Submits/creates a consent form. Grouped with release-form and release-form-proof endpoints for content compliance. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit contact form](/docs/of-api/misc/submit-contact-form): Submits the contact page form data. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit legal inquiry by counsel](/docs/of-api/misc/submit-legal-inquiry-by-counsel): Submits a legal inquiry on behalf of legal counsel. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit legal inquiry response](/docs/of-api/misc/submit-legal-inquiry-response): Submits data/response for a specific legal inquiry. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit license form](/docs/of-api/misc/submit-license-form): Submits a license form for the current user (identity/creator license documentation). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit release form proof](/docs/of-api/misc/submit-release-form-proof): Submits proof for a content release form (consent documentation). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Toggle release form visibility](/docs/of-api/misc/toggle-release-form-visibility): Toggles the show/visibility state of release forms. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update a legal inquiry](/docs/of-api/misc/update-a-legal-inquiry): Submits an update to a legal inquiry identified by its ID and hash. Part of the legal-inquiry module (search, history, change-status). OnlyFans only — Fansly accounts are…
- [Update a localization text](/docs/of-api/misc/update-a-localization-text): Updates the localized text string for a given text code. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Upload release form document](/docs/of-api/misc/upload-release-form-document): Uploads a release-form document (co-performer consent / model release). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Notifications](/docs/of-api/notifications): OnlyFans notification endpoints (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Delete user alert](/docs/of-api/notifications/delete-user-alert): Deletes a user alert by id. Related to users/mass-alert endpoints (creator alert broadcasts). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Dismiss a mass alert](/docs/of-api/notifications/dismiss-a-mass-alert): Dismisses/deletes a mass alert notification identified by alert id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get notification tabs order](/docs/of-api/notifications/get-notification-tabs-order): Returns the user's configured ordering of notification tabs. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get notifications](/docs/of-api/notifications/get-notifications-get): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get unread notification count](/docs/of-api/notifications/get-unread-notification-count): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get user alerts](/docs/of-api/notifications/get-user-alerts): Returns the current user's alert(s) banner data. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Mark all notifications as read](/docs/of-api/notifications/mark-all-notifications-as-read): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Mark notification as read](/docs/of-api/notifications/mark-notification-as-read): Marks a single notification as read by its id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Register PWA push token](/docs/of-api/notifications/register-pwa-push-token): Registers or updates the web-push (PWA) push notification token for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Save notification tabs order](/docs/of-api/notifications/save-notification-tabs-order): Saves the ordering of the notification settings tabs. A GET on the same path retrieves the current order. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Payouts](/docs/of-api/payouts): OnlyFans payout & payment endpoints (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Add payout bank account](/docs/of-api/payouts/add-payout-bank-account): Creates/saves a bank account for payouts. GET on the same path retrieves the current bank details. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Check if any transactions exist](/docs/of-api/payouts/check-if-any-transactions-exist): Returns whether the account has any payment transactions across all payment sources. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Check if VAT documents allowed](/docs/of-api/payouts/check-if-vat-documents-allowed): Returns whether the creator is currently allowed to add VAT documents to their payouts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Check payout receive eligibility](/docs/of-api/payouts/check-payout-receive-eligibility): Checks whether the creator is able to receive payouts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Create a VAT request](/docs/of-api/payouts/create-a-vat-request): Creates a VAT (value-added tax) request for payouts. Part of the payouts tax module (vat, qst, tax, dac7). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Create or update Stripe payout account](/docs/of-api/payouts/create-or-update-stripe-payout-account): Submits Stripe connected-account details used for creator payouts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Create payout request](/docs/of-api/payouts/create-payout-request-post): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Delete a payment card](/docs/of-api/payouts/delete-a-payment-card): Removes a saved payment card from the user's account. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete alternative payment method](/docs/of-api/payouts/delete-alternative-payment-method): Removes a saved alternative payment method, identified by id in the request body. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete bank payout method](/docs/of-api/payouts/delete-bank-payout-method): Removes the creator's configured bank account used for payouts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete VAT number](/docs/of-api/payouts/delete-vat-number): Removes the creator's VAT registration number. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Download VAT document](/docs/of-api/payouts/download-vat-document): Downloads a specific VAT document/invoice for payouts by its id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get all payment transactions](/docs/of-api/payouts/get-all-payment-transactions): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get chargeback ratio](/docs/of-api/payouts/get-chargeback-ratio): Returns the chargeback-to-transaction ratio for the given date range.
- [Get chargebacks chart data](/docs/of-api/payouts/get-chargebacks-chart-data): Time-series chart data for chargebacks with totals and delta.
- [Get DAC7 tax info](/docs/of-api/payouts/get-dac7-tax-info): Retrieves the creator's stored DAC7 (EU platform reporting) tax information for payouts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get earnings chart](/docs/of-api/payouts/get-earnings-chart): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get payout account info](/docs/of-api/payouts/get-payout-account-info): Get saved banking/payment method info for payouts.
- [Get payout balances](/docs/of-api/payouts/get-payout-balances): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get payout legal form](/docs/of-api/payouts/get-payout-legal-form): Retrieves the legal form data required for payouts (tax/identity legal form). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get payout legal info](/docs/of-api/payouts/get-payout-legal-info): Retrieves the creator's payout legal information. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get payout transactions](/docs/of-api/payouts/get-payout-transactions): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get payout VAT info](/docs/of-api/payouts/get-payout-vat-info): Retrieves the user's VAT information used for payouts (POST on the same path submits the VAT number). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get PayPal payment method info](/docs/of-api/payouts/get-paypal-payment-method-info): Returns the current PayPal alternative payment method configuration/status for the user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get referral earnings balance](/docs/of-api/payouts/get-referral-earnings-balance): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get referrals chart data](/docs/of-api/payouts/get-referrals-chart-data): Time-series chart data for referral earnings with totals and delta.
- [Get Stripe payout info](/docs/of-api/payouts/get-stripe-payout-info): Retrieves the creator's Stripe payout account information. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get Stripe payout legal info](/docs/of-api/payouts/get-stripe-payout-legal-info): Retrieves the Stripe payout legal/agreement information for the creator. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get UK company payout data](/docs/of-api/payouts/get-uk-company-payout-data): Returns the creator's stored UK company details used for payouts/tax. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get VAT info for payout request](/docs/of-api/payouts/get-vat-info-for-payout-request): Returns VAT details associated with a specific payout request. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List alternative payment methods](/docs/of-api/payouts/list-alternative-payment-methods): Returns the available alternative (non-card) payment methods for the user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List chargebacks / disputes](/docs/of-api/payouts/list-chargebacks-disputes): Paginated list of chargeback transactions. Uses marker-based pagination.
- [List payout requests](/docs/of-api/payouts/list-payout-requests): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [List payout-supported countries](/docs/of-api/payouts/list-payout-supported-countries): Returns the list of countries supported/available for creator payouts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List payout VAT records](/docs/of-api/payouts/list-payout-vat-records): Retrieves the list of VAT records associated with the creator's payouts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List referral payout requests](/docs/of-api/payouts/list-referral-payout-requests-get): Paginated list of referral payout transactions. Uses marker-based pagination.
- [List saved payment cards](/docs/of-api/payouts/list-saved-payment-cards): Returns the fan's saved payment cards. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List Stripe payout requests](/docs/of-api/payouts/list-stripe-payout-requests): Returns the creator's Stripe payout requests, paginated by lastPayoutId. The dynamic path segment is actually the querystring. OnlyFans only — Fansly accounts are rejected…
- [Pay via alternative method](/docs/of-api/payouts/pay-via-alternative-method): Submits a payment through an alternative payment method (e.g. PayPal). Related GET/POST endpoints handle the alternative-payment-methods form and listing. OnlyFans only —…
- [Save address](/docs/of-api/payouts/save-address): Submits/saves an address for the user; appears alongside payout/Stripe and country endpoints, suggesting a payout or billing address. OnlyFans only — Fansly accounts are…
- [Set default payment card](/docs/of-api/payouts/set-default-payment-card): Marks the specified saved payment card as the account's default card. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit a payment](/docs/of-api/payouts/submit-a-payment): Processes/submits a payment. Part of the payments module alongside 3ds-js and cards endpoints. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit alternative payment method form](/docs/of-api/payouts/submit-alternative-payment-method-form): Submits the form for an alternative payment method. A GET on the same path retrieves the form definition. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit DAC7 tax information](/docs/of-api/payouts/submit-dac7-tax-information): Submits the creator's DAC7 (EU tax reporting) information. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit Instagram legal verification](/docs/of-api/payouts/submit-instagram-legal-verification): Submits legal/identity verification information via an Instagram account for payouts. Sibling of payouts/legal and payouts/legal/twitter. OnlyFans only — Fansly accounts…
- [Submit payout legal information](/docs/of-api/payouts/submit-payout-legal-information): Submits the creator's legal/identity information required for payouts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit payout tax info](/docs/of-api/payouts/submit-payout-tax-info): Submits creator tax information for the payouts flow. Body is passed as the payload property. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit QST tax information](/docs/of-api/payouts/submit-qst-tax-information): Submits the creator's QST (Quebec sales tax) information. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit Stripe payout legal info](/docs/of-api/payouts/submit-stripe-payout-legal-info): Submits legal information for a Stripe-based payout account. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit taxpayer identification number](/docs/of-api/payouts/submit-taxpayer-identification-number): Submits the creator's taxpayer identification number (TIN) for payout tax compliance. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit Twitter legal info](/docs/of-api/payouts/submit-twitter-legal-info): Submits Twitter/X account legal verification information for the payouts legal flow. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit UK company payout data](/docs/of-api/payouts/submit-uk-company-payout-data): Submits UK company data (for company/business payout accounts) as part of payout onboarding. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit VAT number](/docs/of-api/payouts/submit-vat-number): Submits the creator's VAT registration number. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit W-9 address](/docs/of-api/payouts/submit-w-9-address): Submits the address associated with the creator's W-9 tax form. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit W-9 tax form](/docs/of-api/payouts/submit-w-9-tax-form): Submits the creator's IRS W-9 tax form data for payouts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update a saved payment card](/docs/of-api/payouts/update-a-saved-payment-card): Updates the details of a saved payment card identified by card_id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update bank payout details](/docs/of-api/payouts/update-bank-payout-details): Partially updates the creator's bank account details used for payouts. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Verify a saved card](/docs/of-api/payouts/verify-a-saved-card): Verifies a stored payment card identified by card id, optionally with verification data. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Verify W9 TIN](/docs/of-api/payouts/verify-w9-tin): Runs a TIN (taxpayer ID) verification check for W9 payout tax information. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Promotions](/docs/of-api/promotions): OnlyFans promotions & trials (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Check and reserve trial code](/docs/of-api/promotions/check-and-reserve-trial-code): Validates a free-trial link code and reserves it for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Claim a promotion by code](/docs/of-api/promotions/claim-a-promotion-by-code): Claims a promotional offer using a promo code. Sends the code with a strictAuthCheck flag. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Claim free trial by code](/docs/of-api/promotions/claim-free-trial-by-code): Claims a free-trial subscription offer using a trial code. The code is sent in the request body. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Create a free trial link](/docs/of-api/promotions/create-a-free-trial-link): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Delete a promotion offer](/docs/of-api/promotions/delete-a-promotion-offer): Deletes a single promotion offer identified by offer_id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete a trial link](/docs/of-api/promotions/delete-a-trial-link): Deletes a free-trial subscription link/campaign identified by trial id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete campaign](/docs/of-api/promotions/delete-campaign): Deletes a promotional campaign by id. Grouped with campaign share-access, claimers and trials endpoints. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete promotion](/docs/of-api/promotions/delete-promotion): Deletes a subscription promotion by its ID. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Finish a promotion](/docs/of-api/promotions/finish-a-promotion): Ends/finishes an active promotion campaign identified by promotion id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get active promotional offers](/docs/of-api/promotions/get-active-promotional-offers): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get free trial links](/docs/of-api/promotions/get-free-trial-links): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get promotion offer by ID](/docs/of-api/promotions/get-promotion-offer-by-id): Fetches a single promotion offer by its ID. Sibling calls in the module handle claiming trials/promotions and confirming emails. OnlyFans only — Fansly accounts are…
- [Get promotions](/docs/of-api/promotions/get-promotions): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get user promotions](/docs/of-api/promotions/get-user-promotions): Retrieves promotions available to the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Hide promotion offers](/docs/of-api/promotions/hide-promotion-offers): Hides the current promotion offers from view. Defined alongside promotions/offers list and delete calls. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Revoke trial share access](/docs/of-api/promotions/revoke-trial-share-access): Revokes shared free-trial access. The request carries a body via the delete data option. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Send promotion invite](/docs/of-api/promotions/send-promotion-invite): Sends an invitation for a promotion/promo offer. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Share trial access](/docs/of-api/promotions/share-trial-access): Creates a shared free-trial access grant. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Transition a campaign state](/docs/of-api/promotions/transition-a-campaign-state): Transitions a promotional campaign to a new state/status. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update trial link](/docs/of-api/promotions/update-trial-link): Updates a trial-subscription link by ID (e.g. finishes/deactivates it). No request body is sent. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Stories](/docs/of-api/stories): OnlyFans stories (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Block user from stories](/docs/of-api/stories/block-user-from-stories): Blocks the specified user from viewing the creator's stories. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Create a new story](/docs/of-api/stories/create-a-new-story): Post a new story. Stories expire after 24 hours.
- [Create a story highlight](/docs/of-api/stories/create-a-story-highlight): Save stories to a permanent highlight collection on your profile. Stories in highlights don't expire.
- [Create story](/docs/of-api/stories/create-story): Creates a new story for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete a story answer](/docs/of-api/stories/delete-a-story-answer): Deletes a viewer's answer/reply to a story (e.g. story question sticker) identified by answer id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get archived stories](/docs/of-api/stories/get-archived-stories): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get story highlights](/docs/of-api/stories/get-story-highlights): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get user's stories](/docs/of-api/stories/get-user-s-stories): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get your active stories](/docs/of-api/stories/get-your-active-stories): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Like a story](/docs/of-api/stories/like-a-story): Likes the story identified by story_id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List story-blocked users](/docs/of-api/stories/list-story-blocked-users): Returns users blocked from viewing the current user's stories. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List story viewers](/docs/of-api/stories/list-story-viewers): Returns the list of viewers for a story, with pagination; a variant filters to only viewers who tipped. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Mark story as watched](/docs/of-api/stories/mark-story-as-watched): Marks a story as watched/seen by the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Unblock user from stories](/docs/of-api/stories/unblock-user-from-stories): Removes a user from the story block list (unblocks them from viewing stories). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Unlike a story](/docs/of-api/stories/unlike-a-story): Removes a like from the specified story. Paired with a POST on the same path to like it. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Streams](/docs/of-api/streams): OnlyFans live streams (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Accept dual-stream invite](/docs/of-api/streams/accept-dual-stream-invite): Accepts an invitation to join a dual (co-host) live stream identified by stream id (acceptDualStreamInvite). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Accept dual-stream request](/docs/of-api/streams/accept-dual-stream-request): Accepts a user's request to join a dual/co-stream (acceptDualStreamRequest). Sibling calls decline, cancel or invite users. OnlyFans only — Fansly accounts are rejected on…
- [Add likes to stream](/docs/of-api/streams/add-likes-to-stream): Adds a number of likes to a live stream (streamLikes). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add stream helper](/docs/of-api/streams/add-stream-helper): Grants a user helper (moderator) permissions on a live stream. Enclosing fn addStreamHelper. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Block stream viewer](/docs/of-api/streams/block-stream-viewer): Blocks a viewer in a live stream, optionally permanently. Called as blockStreamViewer({streamId, userId, isPermanent}). OnlyFans only — Fansly accounts are rejected on…
- [Block stream viewer by name](/docs/of-api/streams/block-stream-viewer-by-name): Blocks a live-stream viewer identified by their username (blockStreamViewerByName). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Cancel dual-stream invite](/docs/of-api/streams/cancel-dual-stream-invite): Cancels a pending dual-stream (co-stream) invite for a user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Cancel dual-stream request](/docs/of-api/streams/cancel-dual-stream-request): Cancels a pending dual-stream (co-streaming) request for the given stream (enclosing fn cancelDualStreamRequest). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Check if current user is viewer](/docs/of-api/streams/check-if-current-user-is-viewer): Checks whether the current user is a viewer of the given stream (checkViewer). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Check if stream active](/docs/of-api/streams/check-if-stream-active): Checks whether the specified live stream is currently active. Enclosing fn checkStreamActive. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Create / start a live stream](/docs/of-api/streams/create-start-a-live-stream): Start a new live stream. Returns stream configuration including the room ID and streaming credentials.
- [Decline dual-stream invite](/docs/of-api/streams/decline-dual-stream-invite): Declines an invitation to join a dual (co-host) live stream. Enclosing fn declineDualStreamInvite. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Decline dual-stream request](/docs/of-api/streams/decline-dual-stream-request): Declines a dual-stream (co-stream) request from a user (declineDualStreamRequest). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete a stream](/docs/of-api/streams/delete-a-stream): Deletes a live stream identified by stream id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete stream comment](/docs/of-api/streams/delete-stream-comment): Removes a comment from a live stream. Called as removeComment(streamId, commentId). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Fetch stream covers](/docs/of-api/streams/fetch-stream-covers): Fetches available cover images for a stream (fetchStreamCovers). Retries on HTTP 400. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Finish a live stream](/docs/of-api/streams/finish-a-live-stream): Ends the live stream identified by stream_id. Enclosing fn is finishStream. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get a single stream comment](/docs/of-api/streams/get-a-single-stream-comment): Fetches a single comment on a live stream by stream and comment id (enclosing fn getStreamComment). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get a stream viewer](/docs/of-api/streams/get-a-stream-viewer): Retrieves details for a single viewer of a live stream. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get active live streams](/docs/of-api/streams/get-active-live-streams): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get stream details](/docs/of-api/streams/get-stream-details): Retrieves a live stream by its id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get stream statistics](/docs/of-api/streams/get-stream-statistics): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get stream viewers](/docs/of-api/streams/get-stream-viewers): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Hide stream](/docs/of-api/streams/hide-stream): Hides the specified live stream from the feed. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Invite user to dual stream](/docs/of-api/streams/invite-user-to-dual-stream): Invites a user to join a dual/co-stream. Called as inviteDualStream({streamId, userId}). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Join a dual stream](/docs/of-api/streams/join-a-dual-stream): Requests to join a dual (co-host) live stream identified by stream_id. Enclosing fn is joinDualStreamRequest. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Kick a user from stream](/docs/of-api/streams/kick-a-user-from-stream): Remove a viewer from the live stream (creator only).
- [Mark viewing a stream](/docs/of-api/streams/mark-viewing-a-stream): Registers the current user as actively looking at the stream. Enclosing fn is streamLook. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Pin a stream comment](/docs/of-api/streams/pin-a-stream-comment): Pins a comment within a live stream (DELETE on the same path unpins it). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Remove a user's stream comments](/docs/of-api/streams/remove-a-user-s-stream-comments): Removes all comments from a specific user within a live stream (removeComment by user). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Remove stream helper](/docs/of-api/streams/remove-stream-helper): Removes a user's helper (moderator) role on a live stream. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Remove stream reminder](/docs/of-api/streams/remove-stream-reminder): Removes the reminder the user set for the scheduled stream identified by stream_id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Save live stream cover](/docs/of-api/streams/save-live-stream-cover): Saves/updates the cover image for a live stream (enclosing fn saveStreamCover). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Save stream as a post](/docs/of-api/streams/save-stream-as-a-post): Saves a finished live stream as a feed post (saveStreamAsPost). Requires the stream ID and additional post fields. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Set stream reminder](/docs/of-api/streams/set-stream-reminder): Sets a reminder for an upcoming/scheduled live stream. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Share stream to Twitter](/docs/of-api/streams/share-stream-to-twitter): Tweets/shares the live stream identified by stream_id with preview options. Enclosing fn is sendStreamTweet. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Stop looking at a stream](/docs/of-api/streams/stop-looking-at-a-stream): Removes the current viewer's 'look' marker on a stream (streamUnlook). Paired with a POST on the same path (streamLook). OnlyFans only — Fansly accounts are rejected on…
- [Stream discovery feed](/docs/of-api/streams/stream-discovery-feed): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Unblock stream viewer](/docs/of-api/streams/unblock-stream-viewer): Unblocks a previously blocked live-stream viewer by user ID. Enclosing fn unblockStreamViewerByUserId. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Unpin a stream comment](/docs/of-api/streams/unpin-a-stream-comment): Removes the pin from a comment on a live stream. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update a stream](/docs/of-api/streams/update-a-stream): Updates properties of an existing live stream. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Vote on a stream poll](/docs/of-api/streams/vote-on-a-stream-poll): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Subscribers](/docs/of-api/subscribers): OnlyFans subscriber endpoints (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Get subscriber count](/docs/of-api/subscribers/get-subscriber-count): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [List subscribers](/docs/of-api/subscribers/list-subscribers-get): Full subscriber list with total-spent data.
- [Recently expired subscribers](/docs/of-api/subscribers/recently-expired-subscribers): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Subscriber awards count](/docs/of-api/subscribers/subscriber-awards-count): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Top-spending subscribers](/docs/of-api/subscribers/top-spending-subscribers): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Subscriptions](/docs/of-api/subscriptions): OnlyFans subscription management (via proxy). **OnlyFans only** — Fansly accounts are rejected on this surface.
- [Apply subscription discount](/docs/of-api/subscriptions/apply-subscription-discount): Apply a percentage discount to a specific subscriber's subscription. Useful for retention or promotional pricing for individual fans.
- [Delete subscription bundle](/docs/of-api/subscriptions/delete-subscription-bundle): Deletes a subscription bundle offer. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Dismiss price-change hint](/docs/of-api/subscriptions/dismiss-price-change-hint): Dismisses the price-change hint/notice for a subscription. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Dismiss subscription attention flag](/docs/of-api/subscriptions/dismiss-subscription-attention-flag): Clears/dismisses the 'attention' flag on a subscription. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Hide posts from subscription](/docs/of-api/subscriptions/hide-posts-from-subscription): Hides posts from the given subscription in the user's feed. Paired with a DELETE on the same path to unhide. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List unsubscribe reasons](/docs/of-api/subscriptions/list-unsubscribe-reasons): Returns the selectable reasons offered when a fan unsubscribes. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List your subscriptions](/docs/of-api/subscriptions/list-your-subscriptions): Accounts you are subscribed to.
- [Resubscribe to a user](/docs/of-api/subscriptions/resubscribe-to-a-user): Resubscribes to the given user's account. Sibling of users/{id}/subscribe. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Subscribe to a user](/docs/of-api/subscriptions/subscribe-to-a-user): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Subscription count](/docs/of-api/subscriptions/subscription-count): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Subscription payment history](/docs/of-api/subscriptions/subscription-payment-history): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Unhide subscription posts](/docs/of-api/subscriptions/unhide-subscription-posts): Re-shows posts from a subscription previously hidden (PUT on the same path hides them). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Unsubscribe from a user](/docs/of-api/subscriptions/unsubscribe-from-a-user): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Update a subscription](/docs/of-api/subscriptions/update-a-subscription): Updates settings for the given subscription. Sibling calls manage autoprolong, hide-posts and price-change hints. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update subscription bundle](/docs/of-api/subscriptions/update-subscription-bundle): Updates a subscription bundle (discounted multi-month offer) by ID. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [User](/docs/of-api/user): Direct proxy to OnlyFans user profile & settings endpoints. **OnlyFans only.** Requires `X-API-Key` + `user-id` headers.
- [Add or update account helper](/docs/of-api/user/add-or-update-account-helper): Grants or updates an account helper (team member) identified by user_id, assigning the given permission set. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add profile link](/docs/of-api/user/add-profile-link): Adds a custom link to the current user's profile. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Add social buttons](/docs/of-api/user/add-social-buttons): Adds social/link buttons to the user's profile using the provided button IDs. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Block a user](/docs/of-api/user/block-a-user): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Cancel account deletion request](/docs/of-api/user/cancel-account-deletion-request): Cancels a previously submitted account-deletion request. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Cancel pending email change](/docs/of-api/user/cancel-pending-email-change): Cancels a pending email-change request (POST on the same path initiates one). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Cancel pending phone change](/docs/of-api/user/cancel-pending-phone-change): Cancels a pending phone-number change request (POST on the same path initiates one). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Change password](/docs/of-api/user/change-password): Changes the current user's account password. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Check account email](/docs/of-api/user/check-account-email): Triggers an email check for the account (av module). Called with no arguments. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Check if username exists](/docs/of-api/user/check-if-username-exists): Checks whether a username is already taken. Body carries the username to check. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Confirm OTP code](/docs/of-api/user/confirm-otp-code): Confirms/enables one-time-password (2FA) by submitting the verification code. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Connect a linked account](/docs/of-api/user/connect-a-linked-account): Connects/links another account to the current user (used for multi-account switching). Paired with DELETE /users/connect/{id}. OnlyFans only — Fansly accounts are rejected…
- [Connect OpenSea wallet](/docs/of-api/user/connect-opensea-wallet): Links an OpenSea (crypto) wallet to the current user account. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Connect Spring merch account](/docs/of-api/user/connect-spring-merch-account): Connects/saves the user's Spring (merch) social integration (DELETE unlinks it, GET retrieves it). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete a social button](/docs/of-api/user/delete-a-social-button): Deletes a profile social/link button identified by button_id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete a user link](/docs/of-api/user/delete-a-user-link): Deletes one of the user's profile links by id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Delete a WebAuthn credential](/docs/of-api/user/delete-a-webauthn-credential): Removes a registered WebAuthn (passkey/security key) credential for the current user; the credential identifier is sent in the request body. OnlyFans only — Fansly accounts…
- [Delete mass message hint](/docs/of-api/user/delete-mass-message-hint): Deletes a mass-message hint for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Disable two-factor OTP](/docs/of-api/user/disable-two-factor-otp): Disables two-factor authentication (OTP) for the account using a verification code. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Disconnect a linked account](/docs/of-api/user/disconnect-a-linked-account): Disconnects a linked/connected account identified by account_id. Enclosing fn is a disconnect helper. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Disconnect OpenSea wallet](/docs/of-api/user/disconnect-opensea-wallet): Removes the connected OpenSea crypto wallet from the current user account. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Disconnect social network](/docs/of-api/user/disconnect-social-network): Disconnects/unlinks a social network account (defaults to twitter) from the profile. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Disconnect Spring integration](/docs/of-api/user/disconnect-spring-integration): Disconnects/removes the user's linked Spring (merch) social integration. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Dismiss a recommended user](/docs/of-api/user/dismiss-a-recommended-user): Removes/dismisses a suggested (recommended) user identified by user_id. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Dismiss user hint](/docs/of-api/user/dismiss-user-hint): Dismisses a UI hint/recommendation by ID for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Enable phone OTP](/docs/of-api/user/enable-phone-otp): Enables/requests one-time-password (2FA) delivery via phone for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get account settings](/docs/of-api/user/get-account-settings): Returns account-level settings including banking status, payout eligibility, and verification state.
- [Get auth token](/docs/of-api/user/get-auth-token): Retrieves an authentication token for the user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get creator start date](/docs/of-api/user/get-creator-start-date): Returns the current user's creator/model start-date information. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get current auth token](/docs/of-api/user/get-current-auth-token): Retrieves an auth token for the current user (used for authenticated sub-flows). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get current user ID](/docs/of-api/user/get-current-user-id): Returns the ID of the currently authenticated user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get current user profile](/docs/of-api/user/get-current-user-profile): Returns the authenticated user's full profile including stats, subscription info, and settings. Call via the generic proxy endpoint.
- [Get notification transport settings](/docs/of-api/user/get-notification-transport-settings): Returns the available/enabled notification transport channels (email, push, etc.) for the user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get OTP backup codes](/docs/of-api/user/get-otp-backup-codes): Returns the current user's strong OTP (backup/recovery) codes. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get OTP token](/docs/of-api/user/get-otp-token): Exchanges credentials for a one-time-password token. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get pinned friends](/docs/of-api/user/get-pinned-friends): Returns a user's pinned friends. Called as getPinnedFriends({userId}). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get profile QR code](/docs/of-api/user/get-profile-qr-code): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get social buttons](/docs/of-api/user/get-social-buttons): Retrieves the current user's configured social media buttons/links. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get Telegram link info](/docs/of-api/user/get-telegram-link-info): Returns the Telegram linking information/URL for connecting the account to Telegram. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get user links](/docs/of-api/user/get-user-links): Retrieves the current user's configured profile links. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get user public profile](/docs/of-api/user/get-user-public-profile): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Get user's links](/docs/of-api/user/get-user-s-links): Retrieves the profile links configured by a user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get user social buttons](/docs/of-api/user/get-user-social-buttons): Retrieves the social/link buttons configured on a user's profile. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get WebSocket auth token](/docs/of-api/user/get-websocket-auth-token): Returns authentication data/token needed to establish the realtime WebSocket connection. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Get Yoti face-ID verification URL](/docs/of-api/user/get-yoti-face-id-verification-url): Returns a Yoti face-ID identity-verification URL for the given identifiers. Part of the /iv identity-verification module (also yoti-redirect-url). OnlyFans only — Fansly…
- [Get Yoti identity verification URL](/docs/of-api/user/get-yoti-identity-verification-url): Retrieves a Yoti identity-verification redirect URL for the identity verification (iv) flow. Sibling call fetches a Yoti face-ID URL. OnlyFans only — Fansly accounts are…
- [List active sessions](/docs/of-api/user/list-active-sessions): Retrieves the current user's active login sessions. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List blocked users](/docs/of-api/user/list-blocked-users): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [List login sessions](/docs/of-api/user/list-login-sessions): Returns the account's login sessions/history. Paired with DELETE /logins/{id} to revoke a session. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List user's Shopify stores](/docs/of-api/user/list-user-s-shopify-stores): Retrieves the Shopify stores connected to a given user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [List WebAuthn credentials](/docs/of-api/user/list-webauthn-credentials): Returns the current user's registered WebAuthn (passkey/security key) credentials. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Log in as a helper](/docs/of-api/user/log-in-as-a-helper): Impersonates/switches into a helper (team member) account identified by helper id. Paired with POST /users/helper-logout. OnlyFans only — Fansly accounts are rejected on…
- [Log in user](/docs/of-api/user/log-in-user): Authenticates a user and starts a session. Accepts login credentials in the request body. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Log out current user](/docs/of-api/user/log-out-current-user): Logs out the currently authenticated user session. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Log out helper session](/docs/of-api/user/log-out-helper-session): Ends a helper (login-as-helper) session and returns to the primary account. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Mark device as trusted](/docs/of-api/user/mark-device-as-trusted): Marks the current session/device as trusted. Found next to webauthn, oauth/confirm and logout auth calls. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Postpone face-ID verification](/docs/of-api/user/postpone-face-id-verification): Postpones the required Face ID identity verification step. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Record a profile visit](/docs/of-api/user/record-a-profile-visit): Records a profile visit event; a sibling POST /users/profile/view records profile views. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Record cookie consent](/docs/of-api/user/record-cookie-consent): Stores the user's accepted cookie/consent preferences. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Record profile view](/docs/of-api/user/record-profile-view): Records that the current user viewed a profile (paired with users/profile/visit). Retries once on failure. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Register a new user account](/docs/of-api/user/register-a-new-user-account): Registers a new user account. The request body carries the registration form fields. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Register social button click](/docs/of-api/user/register-social-button-click): Records a click on a user's social button. Part of the profile social-buttons feature. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Remove account helper](/docs/of-api/user/remove-account-helper): Removes a helper (delegated team member) from the account. Related calls manage helper permissions and login-as-helper. OnlyFans only — Fansly accounts are rejected on…
- [Remove account password](/docs/of-api/user/remove-account-password): Deletes the current user's password (e.g. for social-login-only accounts). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Report login issue](/docs/of-api/user/report-login-issue): Submits a login issue report (support). Called with an optional payload object. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Request account deletion](/docs/of-api/user/request-account-deletion): Submits a request to delete the current user's account. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Request alternative OTP method](/docs/of-api/user/request-alternative-otp-method): Requests an alternative one-time-password (2FA) delivery method. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Request email address change](/docs/of-api/user/request-email-address-change): Initiates a change of the account's email address. A DELETE on the same path cancels a pending change. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Request OTP code](/docs/of-api/user/request-otp-code): Requests/retrieves a one-time password (OTP) code for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Request password reset](/docs/of-api/user/request-password-reset): Initiates a forgot-password / password-reset request. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Request phone number change](/docs/of-api/user/request-phone-number-change): Initiates a change of the account's phone number. A DELETE on the same path cancels a pending change. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Resend confirmation email](/docs/of-api/user/resend-confirmation-email): Resends the account confirmation/verification email. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Restore account access with code](/docs/of-api/user/restore-account-access-with-code): Restores access to a user account using a provided restore/verification code. Sent with a skip429Alert retry config. OnlyFans only — Fansly accounts are rejected on…
- [Restrict a user](/docs/of-api/user/restrict-a-user): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Revoke a login session](/docs/of-api/user/revoke-a-login-session): Revokes/removes an active login session identified by login id. Paired with GET /logins which lists active sessions. OnlyFans only — Fansly accounts are rejected on…
- [Revoke all sessions](/docs/of-api/user/revoke-all-sessions): Terminates the user's active login sessions (used in the sessions settings screen). OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Set OpenSea NFT profile item](/docs/of-api/user/set-opensea-nft-profile-item): Updates the OpenSea NFT associated with the user's profile. Sibling calls manage the linked OpenSea wallet and asset listings. OnlyFans only — Fansly accounts are rejected…
- [Set Spotify anthem](/docs/of-api/user/set-spotify-anthem): Sets the user's Spotify profile anthem track. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Set top Spotify artists](/docs/of-api/user/set-top-spotify-artists): Sets the user's top Spotify artists shown on their profile. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Start age verification](/docs/of-api/user/start-age-verification): Initiates the age verification flow. Grouped with iv/start and face-id/start identity checks. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Start Face ID verification](/docs/of-api/user/start-face-id-verification): Starts a Face ID (biometric identity) verification session. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Start identity verification](/docs/of-api/user/start-identity-verification): Starts an identity-verification (IV) flow for the user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Submit account appeal](/docs/of-api/user/submit-account-appeal): Submits an appeal, e.g. against an account restriction or moderation action. Defined near reports/reasons and unsubscribe/reasons calls. OnlyFans only — Fansly accounts are…
- [Switch to connected account](/docs/of-api/user/switch-to-connected-account): Switches the active session to a connected/linked user account. Defined near users/connect and users/get-auth-token. OnlyFans only — Fansly accounts are rejected on…
- [Unblock a user](/docs/of-api/user/unblock-a-user): OnlyFans only. Requests made with a user-id belonging to a Fansly account are rejected — use the platform-neutral CRM data routes (/notifications, /balances,…
- [Update a social button](/docs/of-api/user/update-a-social-button): Updates a single social button by id on the user's profile. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update a user link](/docs/of-api/user/update-a-user-link): Updates one of the user's external profile links. Sibling calls list, create and delete links. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update message settings](/docs/of-api/user/update-message-settings): Updates the current user's messaging settings. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update notification settings](/docs/of-api/user/update-notification-settings): Updates the account's notification settings. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Update social profile buttons](/docs/of-api/user/update-social-profile-buttons): Updates the configuration of the user's social profile buttons. Sibling calls add, reorder, delete and track clicks on these buttons. OnlyFans only — Fansly accounts are…
- [Update user profile](/docs/of-api/user/update-user-profile): Update profile fields. Supports display name, about text, subscription price, tip settings, and more. Only include the fields you want to change.
- [Update user settings section](/docs/of-api/user/update-user-settings-section): Replaces the settings for a specific settings section of the current user. The section key is the path param and the settings payload is the body. OnlyFans only — Fansly…
- [Update user settings section](/docs/of-api/user/update-user-settings-section-patch): Partially updates a named section of the current user's settings. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Validate current user data](/docs/of-api/user/validate-current-user-data): Validates submitted profile/account data for the current user. OnlyFans only — Fansly accounts are rejected on /api2/v2/.
- [Verify OTP code](/docs/of-api/user/verify-otp-code): Verifies a one-time password code. Grouped with users/otp code/phone/alternative endpoints. OnlyFans only — Fansly accounts are rejected on /api2/v2/.