FAfanvue

Get subscribers

Changed on

Returns a paginated list of users who have subscriptions to the authenticated user.

<Info> **Polling for real-time updates? Use a webhook instead.**

If you are calling this endpoint on a schedule to detect new activity, subscribe to the creator.subscription.activated, creator.subscription.cancel_at_period_end_changed, creator.subscription.deactivated webhook events instead — you'll get pushed updates in real time without polling. See the webhook documentation. </Info>

get/subscribers

Request

  • Base URL
    https://api.fanvue.com
  • URL
    https://api.fanvue.com/subscribers
  • Auth
    OAuth 2
    Authorization code: https://auth.fanvue.com/oauth2/auth
    Token URL: https://auth.fanvue.com/oauth2/token scopes: read:fan

Query parameters

pageinteger

Page number to retrieve (starts from 1)

sizeinteger

Number of items to return per page (1-50, default: 15)

sortField'name' | 'subscribedAt'

Public field to sort by

sortDirection'asc' | 'desc'

Sort direction

startDatestring date-time

Only include users whose subscription started on or after this ISO 8601 datetime (e.g., 2024-10-20T00:00:00Z).

endDatestring date-time

Only include users whose subscription started before this ISO 8601 datetime (non-inclusive).

cursorstring

Opaque pagination cursor from a previous response's pagination.nextCursor. When provided, page, sortField, sortDirection, startDate, and endDate are ignored (the cursor carries them); size applies when explicitly passed. Cursor pagination is more efficient than page-based pagination for iterating over large subscriber lists.

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

List of subscribers

Changes

  • 7b1c33d6c706Revision changes
    • info

      added the required property /// to the response with the status