Skip to main content
GET
Get list of chats
Required scope
  • read:chat — Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history.

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
customListId
string<uuid>

Filter chats by custom list UUID

userUuids
string<uuid>[]

Filter chats to these counterpart (fan) user UUIDs (repeat the param for multiple)

smartListIds
enum<string>[]

Filter chats by smart list type(s)

Available options:
subscribers,
auto_renewing,
non_renewing,
followers,
free_trial_subscribers,
expired_subscribers,
spent_more_than_50,
muted,
creators
filter
enum<string>[]

Filter types to apply (can specify multiple via repeated params)

Available options:
unread,
subscribers,
followers,
online,
recent_subscribers,
not_answered,
spent_more_than_50,
on_free_trial,
has_tipped,
spenders,
exclude_creators,
subscribed_to,
not_muted,
archived

Search term to filter chats by user name/handle

Maximum string length: 100
sortBy
enum<string>

Sort order for chat list (default: most_recent_messages)

Available options:
most_recent_messages,
online_now,
most_unanswered_chats
sortDirection
enum<string>

Sort direction for chat list (default: desc)

Available options:
asc,
desc

Response

List of chats

data
object[]
required

Array of chat conversations

pagination
object
required

Pagination information