Chats

List Chats

Lists chat conversations for an OnlyFans account. Returned in real time from OnlyFans. Requires permission api_chats_list.

https://public-api.fansmetric.com

GET/v1/{account_id}/chats

API keyBearer

Authorization

default

AuthorizationBearer <token>

Send your FansMetric API key as a Bearer token in the Authorization header.

In: header

Path Parameters

account_id*integer
OnlyFans numeric account ID.

Query Parameters

limitinteger
Number of chats to return. Default 10. Min 1, max 100.
offsetinteger
Offset for pagination. Default 0.
skip_usersstring
all (default) omits user objects in the response; none includes them.
orderstring
recent (default) or old.
filterstring
Filter chats: priority, pinned, unread, or who_tipped. Mutually exclusive with list_id.
list_idinteger
Custom list ID (from GET /v1/{account_id}/lists). Mutually exclusive with filter.
querystring
Search query — filters chats by username or display name.

Response Fields

data.list[].withUserobject
Fan in the conversation. When skip_users=all, contains only id and _view.
data.list[].lastMessageobject | null
Most recent message — null if there are no messages.
data.list[].lastMessage.idinteger
Message ID of the most recent message.
data.list[].lastMessage.textstring
Text content.
data.list[].lastMessage.isFreeboolean
Whether the message is free.
data.list[].lastMessage.createdAtstring
ISO 8601 timestamp.
data.list[].lastMessage.mediaCountinteger
Media attachment count.
data.list[].lastMessage.isTipboolean
Whether the message represents a tip.
data.list[].lastMessage.fromUserobject
Sender summary { id, _view }.
data.list[].lastMessage.isOpenedboolean
Whether a paid message has been opened/purchased.
data.list[].lastMessage.giphyIdstring | null
Giphy ID if the message is a GIF.
data.list[].lastMessage.lockedTextboolean
Whether text is locked behind a paywall.
data.list[].canSendMessageboolean
Whether the account can send messages to this user.
data.list[].canGoToProfileboolean
Whether the user's profile is accessible.
data.list[].unreadMessagesCountinteger
Number of unread messages.
data.list[].lastReadMessageIdinteger | null
ID of the last message read by the account.
data.list[].hasUnreadTipsboolean
Whether there are unread tips.
data.list[].isMutedNotificationsboolean
Whether notifications are muted for this chat.
data.list[].hasPurchasedFeedboolean
Whether the user has purchased the feed.
data.list[].countPinnedMessagesinteger
Number of pinned messages in this chat.
data.hasMoreboolean
Whether more chats are available.
dataobject | array
Endpoint-specific payload. See the fields below for this route.
_pagination.next_pagestring
Relative URL for the next page, with the cursor or offset already applied. Append it to the API base URL and send it as-is. Omitted entirely on the last page.
_meta._credits.usedinteger
Credits consumed by this request (currently always 1).
_meta._rate_limits.limit_minuteinteger
Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minuteinteger
Remaining requests in the current minute window.
_meta._rate_limits.limit_dayinteger
Maximum requests per day for the organization.
_meta._rate_limits.remaining_dayinteger
Remaining requests in the current day window.

Field	Type	Description
data.list[].withUser	object	Fan in the conversation. When `skip_users=all`, contains only `id` and `_view`.
data.list[].lastMessage	object \| null	Most recent message — `null` if there are no messages.
data.list[].lastMessage.id	integer	Message ID of the most recent message.
data.list[].lastMessage.text	string	Text content.
data.list[].lastMessage.isFree	boolean	Whether the message is free.
data.list[].lastMessage.createdAt	string	ISO 8601 timestamp.
data.list[].lastMessage.mediaCount	integer	Media attachment count.
data.list[].lastMessage.isTip	boolean	Whether the message represents a tip.
data.list[].lastMessage.fromUser	object	Sender summary `{ id, _view }`.
data.list[].lastMessage.isOpened	boolean	Whether a paid message has been opened/purchased.
data.list[].lastMessage.giphyId	string \| null	Giphy ID if the message is a GIF.
data.list[].lastMessage.lockedText	boolean	Whether text is locked behind a paywall.
data.list[].canSendMessage	boolean	Whether the account can send messages to this user.
data.list[].canGoToProfile	boolean	Whether the user's profile is accessible.
data.list[].unreadMessagesCount	integer	Number of unread messages.
data.list[].lastReadMessageId	integer \| null	ID of the last message read by the account.
data.list[].hasUnreadTips	boolean	Whether there are unread tips.
data.list[].isMutedNotifications	boolean	Whether notifications are muted for this chat.
data.list[].hasPurchasedFeed	boolean	Whether the user has purchased the feed.
data.list[].countPinnedMessages	integer	Number of pinned messages in this chat.
data.hasMore	boolean	Whether more chats are available.
data	object \| array	Endpoint-specific payload. See the fields below for this route.
_pagination.next_page	string	Relative URL for the next page, with the cursor or offset already applied. Append it to the API base URL and send it as-is. Omitted entirely on the last page.
_meta._credits.used	integer	Credits consumed by this request (currently always `1`).
_meta._rate_limits.limit_minute	integer	Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minute	integer	Remaining requests in the current minute window.
_meta._rate_limits.limit_day	integer	Maximum requests per day for the organization.
_meta._rate_limits.remaining_day	integer	Remaining requests in the current day window.

curl --request GET "https://public-api.fansmetric.com/v1/100000001/chats?limit=20&offset=0&skip_users=sample_skip_users" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"list":[0:{"withUser":{"id":100000003
"_view":"..."
"username":"user_XXXXX"
"name":"User XX"
}
"lastMessage":{"id":100000004
"text":"Hey there!"
"isFree":true
"createdAt":"2026-05-14T10:30:00+00:00"
"mediaCount":0
"isTip":false
"fromUser":{"id":100000003
"_view":"..."
}
"isOpened":true
"giphyId":null
"lockedText":false
}
"canSendMessage":true
"canGoToProfile":true
"unreadMessagesCount":2
"lastReadMessageId":100000003
"hasUnreadTips":false
"isMutedNotifications":false
"hasPurchasedFeed":false
"countPinnedMessages":0
}
]
"hasMore":true
}
"_pagination":{"next_page":"/v1/100000003/chats?limit=10&offset=10"
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":998
"limit_day":50000
"remaining_day":49998
}
}
}

Get Current Account

Hide Chat