curl --request GET \
--url https://api.fanvue.com/v1/chats \
--header 'Authorization: Bearer <token>' \
--header 'X-Fanvue-API-Version: <x-fanvue-api-version>'import requests
url = "https://api.fanvue.com/v1/chats"
headers = {
"X-Fanvue-API-Version": "<x-fanvue-api-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Fanvue-API-Version': '<x-fanvue-api-version>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.fanvue.com/v1/chats', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"createdAt": "2024-01-15T00:00:00.000Z",
"lastMessageAt": "2024-01-15T00:00:00.000Z",
"isRead": false,
"isMuted": false,
"unreadMessagesCount": 3,
"user": {
"uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"handle": "sarah-jones",
"nickname": "SarahK",
"displayName": "Sarah Jones",
"isTopSpender": true,
"avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
"registeredAt": "2024-01-10T12:00:00.000Z"
},
"isCreator": false,
"online": true,
"lastSeenAt": "2024-01-15T00:00:00.000Z",
"customLists": [
{
"uuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r8",
"name": "VIPs"
}
],
"lastMessage": {
"uuid": "a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6",
"text": "Hey there! How are you doing?",
"type": "SINGLE_RECIPIENT",
"sentAt": "2024-01-15T00:00:00.000Z",
"hasMedia": true,
"hasGif": false,
"mediaType": "image",
"senderUuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r8",
"senderRole": "CREATOR",
"sentByUserId": null,
"status": "Read"
}
},
{
"createdAt": "2024-01-14T00:00:00.000Z",
"lastMessageAt": null,
"isRead": true,
"isMuted": true,
"unreadMessagesCount": 0,
"user": {
"uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"handle": "mike-smith",
"nickname": null,
"displayName": "Mike Smithly",
"isTopSpender": false,
"avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
"registeredAt": "2024-01-10T12:00:00.000Z"
},
"lastMessage": null
},
{
"createdAt": "2024-01-15T00:00:00.000Z",
"lastMessageAt": "2024-01-15T00:00:00.000Z",
"isRead": true,
"isMuted": false,
"unreadMessagesCount": 0,
"user": {
"uuid": "3bbe6394-2830-4646-a8ba-4a0a05426947",
"handle": "johnny-doey",
"nickname": "JohnnyD",
"displayName": "Johnny Doey",
"isTopSpender": true,
"avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
"registeredAt": "2024-01-10T12:00:00.000Z"
},
"lastMessage": {
"uuid": "c3d4e5f6-7890-1234-5678-9abcdef01234",
"text": "Check out my new post!",
"type": "BROADCAST",
"sentAt": "2024-01-15T00:00:00.000Z",
"hasMedia": true,
"hasGif": false,
"mediaType": "image",
"senderUuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r8",
"senderRole": "CREATOR",
"sentByUserId": null,
"status": "Delivered"
}
}
],
"nextCursor": "k0FQ1m9yZXN0aWdpb3VzLW9wYXF1ZS1jdXJzb3I",
"total": null
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>"
}{
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"nextVersion": "<string>"
}{
"error": "<string>"
}Get list of chats (cursor-paginated)
Cursor-paginated list of chat conversations with optional filtering, searching, and sorting. Page with the opaque nextCursor from the previous response.
v1-experimental Breaking Change: Switched from offset-based pagination (page/size) to cursor pagination. For the default recency sort the cursor is a keyset position, so deep pages cost the same as the first and rows are never repeated or shifted past as chats arrive — unlike offset paging. Note that the sort key is live activity: a chat that receives a message mid-traversal moves to the front of the order, so a long walk can pass it by. Re-request the first page to pick up newly active chats. A cursor is only valid for the sortBy and sortDirection it was minted under; reusing it under different sorting returns 400.
Available Filters (via filter parameter):
unread- Only unread chatsonline- Only online userssubscribed_to- Users you’re subscribed tonot_muted- Exclude muted chatsmuted- Only muted chatsarchived- Only archived chatssubscribers- Only subscribers (creator-only)followers- Only followers (creator-only)recent_subscribers- Recently subscribed (creator-only)not_answered- Unanswered chats (creator-only)spent_more_than_50- High spenders (creator-only)on_free_trial- Free trial users (creator-only)has_tipped- Users who have tipped (creator-only)spenders- All spenders (creator-only)exclude_creators- Exclude creator accounts (creator-only)
Sort Options (via sortBy parameter):
most_recent_messages(default) - Sort by most recent messageonline_now- Prioritize online usersmost_unanswered_chats- Sort by unanswered count
Sort Direction (via sortDirection parameter):
desc(default) - Highest-ranked chats first (most recent / most online / most unanswered)asc- Reverses the order (least recent / least online / fewest unanswered)
curl --request GET \
--url https://api.fanvue.com/v1/chats \
--header 'Authorization: Bearer <token>' \
--header 'X-Fanvue-API-Version: <x-fanvue-api-version>'import requests
url = "https://api.fanvue.com/v1/chats"
headers = {
"X-Fanvue-API-Version": "<x-fanvue-api-version>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Fanvue-API-Version': '<x-fanvue-api-version>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.fanvue.com/v1/chats', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"createdAt": "2024-01-15T00:00:00.000Z",
"lastMessageAt": "2024-01-15T00:00:00.000Z",
"isRead": false,
"isMuted": false,
"unreadMessagesCount": 3,
"user": {
"uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"handle": "sarah-jones",
"nickname": "SarahK",
"displayName": "Sarah Jones",
"isTopSpender": true,
"avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
"registeredAt": "2024-01-10T12:00:00.000Z"
},
"isCreator": false,
"online": true,
"lastSeenAt": "2024-01-15T00:00:00.000Z",
"customLists": [
{
"uuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r8",
"name": "VIPs"
}
],
"lastMessage": {
"uuid": "a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6",
"text": "Hey there! How are you doing?",
"type": "SINGLE_RECIPIENT",
"sentAt": "2024-01-15T00:00:00.000Z",
"hasMedia": true,
"hasGif": false,
"mediaType": "image",
"senderUuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r8",
"senderRole": "CREATOR",
"sentByUserId": null,
"status": "Read"
}
},
{
"createdAt": "2024-01-14T00:00:00.000Z",
"lastMessageAt": null,
"isRead": true,
"isMuted": true,
"unreadMessagesCount": 0,
"user": {
"uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"handle": "mike-smith",
"nickname": null,
"displayName": "Mike Smithly",
"isTopSpender": false,
"avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
"registeredAt": "2024-01-10T12:00:00.000Z"
},
"lastMessage": null
},
{
"createdAt": "2024-01-15T00:00:00.000Z",
"lastMessageAt": "2024-01-15T00:00:00.000Z",
"isRead": true,
"isMuted": false,
"unreadMessagesCount": 0,
"user": {
"uuid": "3bbe6394-2830-4646-a8ba-4a0a05426947",
"handle": "johnny-doey",
"nickname": "JohnnyD",
"displayName": "Johnny Doey",
"isTopSpender": true,
"avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
"registeredAt": "2024-01-10T12:00:00.000Z"
},
"lastMessage": {
"uuid": "c3d4e5f6-7890-1234-5678-9abcdef01234",
"text": "Check out my new post!",
"type": "BROADCAST",
"sentAt": "2024-01-15T00:00:00.000Z",
"hasMedia": true,
"hasGif": false,
"mediaType": "image",
"senderUuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r8",
"senderRole": "CREATOR",
"sentByUserId": null,
"status": "Delivered"
}
}
],
"nextCursor": "k0FQ1m9yZXN0aWdpb3VzLW9wYXF1ZS1jdXJzb3I",
"total": null
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>"
}{
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"nextVersion": "<string>"
}{
"error": "<string>"
}read:chat— Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history.
Authorizations
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
API version to use for the request
"2025-06-26"
Query Parameters
Opaque pagination cursor from a previous response's nextCursor
Number of items to return (1-50, default: 15)
1 <= x <= 50Filter chats by custom list UUID
Filter chats to these counterpart (fan) user UUIDs (repeat the param for multiple)
Filter chats by smart list type(s)
subscribers, auto_renewing, non_renewing, followers, free_trial_subscribers, expired_subscribers, spent_more_than_50, muted, creators Filter types to apply (can specify multiple via repeated params)
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 Search term to filter chats by user name/handle
100Sort order for chat list (default: most_recent_messages)
most_recent_messages, online_now, most_unanswered_chats Sort direction for chat list (default: desc)
asc, desc Response
Cursor-paginated list of chats
Was this page helpful?