Before you start
Usesubscribers:read for the subscriber search below. Complete authorization and select a linked account. Install the TypeScript SDK version 4. Create a client on your server:
Use the right ID
Thex-linked-account-id header selects the creator. A fan’s OnlyFans user ID goes in user, subscriber, and message routes. A list ID selects a saved group of fans. Save fan and list IDs with the creator’s linked account ID. Use a fan ID to select one recipient, or a list ID to select a group.
Find subscribers
/v3/access/subscribers for all subscribers, /subscribers/active for active subscribers, and /subscribers/expired for expired subscribers. Choose the route for the subscription status you need.
List responses use { items, page }. Read the results from items. If page.hasMore is true, send page.nextCursor as the next request’s cursor. Keep the same filters.
Subscriber filters
Use
minSpend and spending dates to find fans for a campaign. GET /v3/access/subscribers/count has its own filters, including type, hasAutoprolong, and newPriceLessThan. Use count filters only on that route.
Read one user with GET /v3/access/users/123456. User IDs identify fans on OnlyFans. Linked account IDs identify the account shared with your authorization. Store both IDs together.
Organize user lists
list.id. To find lists, use GET /v3/access/lists, which returns items and page. It accepts limit, cursor, query, filter, and isChat. See the API reference for filter values.
To add one fan, send
POST /v3/access/lists/101/users/123456. To add the fan to multiple lists, send POST /v3/access/users/123456/lists with { "listIds": [101, 202] }. You can send 1 to 5 list IDs. Use DELETE /v3/access/lists/101/users/123456 to remove the fan from the list.
Send to these lists with mass messages. User lists hold fans. Media folders hold files in the Vault.
Record notes and subscriber preferences
Notes accept up to 1,000 characters. Display names accept 1 to 100 characters. Discounts accept whole numbers from 5 to 60 percent and periods from 1 to 12 months.
Restrict or block a fan
Restricting and blocking a fan are separate actions. Check which actions the user response allows. Check the response to your request before updating your app. Restricted and blocked lists accept
limit, cursor, and query.
To send welcome messages, read the active subscriber pages and save each fan’s ID. Then send an individual message. Store the message ID to prevent repeat sends. Use Realtime events to receive updates when new activity occurs.