Sign in
latestOpenAPI 3.1.02026-08-08243131.9 MB

c5ddcd5c7e72

Get list of chats

Returns a paginated list of chat conversations with optional filtering, searching, and sorting.

Available Filters (via filter parameter):

  • unread - Only unread chats
  • online - Only online users
  • subscribed_to - Users you're subscribed to
  • not_muted - Exclude muted chats
  • muted - Only muted chats
  • subscribers - 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 message
  • online_now - Prioritize online users
  • most_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)

<Warning>Some filters are only available to creators. Using creator-only filters as a non-creator will return a 403 error.</Warning>

get/chats

Query parameters

pageinteger

Page number to retrieve (starts from 1)

Page number to retrieve (starts from 1)

sizeinteger

Number of items to return per page (1-50, default: 15)

Number of items to return per page (1-50, default: 15)

customListIdstring uuid

Filter chats by custom list UUID

Filter chats by custom list UUID

userUuidsstring[]

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

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

smartListIdsstring[]

Filter chats by smart list type(s)

Filter chats by smart list type(s)

filterstring[]

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

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

searchstring

Search term to filter chats by user name/handle

Search term to filter chats by user name/handle

sortBy'most_recent_messages' | 'online_now' | 'most_unanswered_chats'

Sort order for chat list (default: most_recent_messages)

Sort order for chat list (default: most_recent_messages)

sortDirection'asc' | 'desc'

Sort direction for chat list (default: desc)

Sort direction for chat list (default: desc)

Headers

X-Fanvue-API-Versionstring required
Example:2025-06-26

API version to use for the request

Response

List of chats