Skip to main content
GET
/
chats
Get list of chats
curl --request GET \
  --url https://api.example.com/chats \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Fanvue-API-Version: <x-fanvue-api-version>'
{
  "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"
      },
      "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,
        "mediaType": "image",
        "senderUuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r8",
        "sentByUserId": null
      }
    },
    {
      "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,
        "mediaType": "image",
        "senderUuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r8",
        "sentByUserId": null
      }
    }
  ],
  "pagination": {
    "page": 1,
    "size": 2,
    "hasMore": false
  }
}
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

​
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
​
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
string

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