Skip to main content
GET
List chats across all agency creators (cursor-paginated, filterable)
Required scopes
  • read:agency — Read agency information, including the agency’s team members.
  • 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

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
updatedAfter
string<date-time>

Incremental sync: only return chats with activity strictly after this timestamp. Chats with no messages are excluded.

Search term to filter chats by counterpart name or handle

Maximum string length: 100
filter
enum<string>[]

Filter types to apply, correlated to each chat's own creator (repeat the param for multiple)

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,
muted,
archived
sortBy
enum<string>

Sort order for the chat list (default: most_recent_messages)

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

Sort direction: desc (highest-ranked first, default) or asc (reversed, for backfills)

Available options:
asc,
desc

Response

Cursor-paginated list of chats across the agency's creators

data
object[]
required

Array of chats across the agency's creators, in the requested sort order

nextCursor
string | null
required

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