Skip to main content
GET
/
subscribers
Get subscribers
curl --request GET \
  --url https://api.example.com/subscribers \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Fanvue-API-Version: <x-fanvue-api-version>'
{
  "data": [
    {
      "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "handle": "sarah-jones",
      "nickname": "SarahK",
      "displayName": "Sarah Jones",
      "isTopSpender": true,
      "avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
      "registeredAt": "2024-01-10T12:00:00.000Z",
      "role": "creator"
    },
    {
      "uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "handle": "mike-smith",
      "nickname": null,
      "displayName": "Mike Smithly",
      "isTopSpender": false,
      "avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
      "registeredAt": "2024-01-10T12:00:00.000Z",
      "role": "creator"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 2,
    "hasMore": false
  }
}
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

Response

List of subscribers

​
data
object[]
required

Array of subscribers

​
pagination
object
required

Pagination information