Skip to main content
GET
List chats across all agency creators
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

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

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

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 for the chat list (default: desc)

Available options:
asc,
desc

Response

Paginated list of chats across the agency's creators

data
object[]
required

Array of chats across the agency's creators

pagination
object
required

Pagination information