Skip to main content
GET
Get custom list members (cursor-paginated)
Required scopes
  • read:chat — Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history.
  • 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

uuid
string<uuid>
required

Custom list UUID

Query Parameters

cursor
string

Opaque pagination cursor from a previous response's nextCursor

size
number
default:15

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

Required range: 1 <= x <= 50

Response

Cursor-paginated list of custom list members

data
object[]
required

Array of list members, most recently added first

nextCursor
string | null
required

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

total
number | null
required

Total number of items, or null when a count is not computed for this list