Skip to main content
GET
Get subscribers
Required scope
  • 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"

Query Parameters

page
number
default:1

Page number to retrieve (starts from 1)

Required range: x >= 1
size
number
default:15

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

Required range: 1 <= x <= 50
sortField
enum<string>

Public field to sort by

Available options:
name,
subscribedAt
sortDirection
enum<string>

Sort direction

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 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.

Response

List of subscribers

data
object[]
required

Array of subscribers

pagination
object
required

Pagination information