Skip to main content
GET
Get creator subscribers (cursor-paginated)
Required scopes
  • read:creator — Access creator profiles, content, and creator-specific information.
  • read:fan — Access fan-related data and information within the platform.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Path Parameters

creatorUserUuid
string<uuid>
required

Query Parameters

sortField
enum<string>

Public field to sort by (default: subscribedAt)

Available options:
name,
subscribedAt
sortDirection
enum<string>

Sort direction (default: desc for subscribedAt, asc for name)

Available options:
asc,
desc
startDate
string<date-time>

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

endDate
string<date-time>

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

cursor
string

Opaque pagination cursor from a previous response's nextCursor. It carries the sortField, sortDirection and date range the first page was cut under, so later pages need nothing but the cursor. Resending those filters is allowed while they match it; a value that contradicts the cursor is rejected.

size
number
default:15

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

Required range: 1 <= x <= 50

Response

Cursor-paginated list of creator subscribers

data
object[]
required

Array of subscribers

nextCursor
string | null
required

Cursor for the next page, or null when there are no more results