Skip to main content
GET
Unread chats

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Query Parameters

limit
integer
default:10

Number of items to return (1-20, default: 10)

Required range: 1 <= x <= 20
cursor
string | null

Cursor from the previous page. Send it to get the next page.

order
enum<string>
default:recent

Sort order: recent (newest first) or old (oldest first)

Available options:
recent,
old
query
string

Text to search for

Maximum string length: 100
listId
integer

Only include chats from this user list.

Required range: x > 0
include_users
enum<string>

Return each chat's user and its lastMessage.sender with their profile (name, username, avatar, avatarThumbs, isVerified, ...), the same profile GET /v3/access/users/{userId} returns. Off by default: then each user is an { id } reference, as OnlyFans returns chat lists.

Available options:
true,
false,
1,
0

Response

Successful response

items
object[]
required
page
object
required