Fanvue API Documentation

curl https://api.fanvue.com/chats/lists/custom \
     -H "X-Fanvue-API-Version: 2025-06-26" \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "VIP Subscribers",
      "membersCount": 47,
      "createdAt": "2024-01-15T10:30:00Z"
    },
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174001",
      "name": "New Followers",
      "membersCount": 128,
      "createdAt": "2024-02-20T09:15:00Z"
    },
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174002",
      "name": "Content Collaborators",
      "membersCount": 23,
      "createdAt": "2024-01-08T11:20:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 20,
    "hasMore": false
  }
}

Get user’s custom lists with member counts. Supports pagination and optional name search.

Scope required: read:chat read:fan

Get user's custom lists with member counts. Supports pagination and optional name search. <Info>Scope required: `read:chat` `read:fan`</Info>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pagedoubleOptional>=1Defaults to 1

Page number to retrieve (starts from 1)

sizedoubleOptional1-50Defaults to 15

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

searchstringOptional

Search term to filter lists by name

Response

List of custom lists

datalist of objects

Array of custom lists

paginationobject

Pagination information

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

410

Gone Error

429

Too Many Requests Error

Get custom lists

Authentication

Headers

Query parameters

Response

Errors