> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onlyfansapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Pinned Chat Messages (/api-reference/chat-messages/list-pinned-chat-messages)
Get pinned messages from a specific chat. Requires API-key read permission.
Returns the same message objects and pagination as [List Chat Messages](https://docs.onlyfansapi.com/api-reference/chat-messages/list-chat-messages). The pinned filter is always applied and cannot be overridden. The original `filter=pinned` listing remains supported.
Use `isPinned` for the current pin state and `canBePinned` for pin eligibility in the standard message response. Follow `_pagination.next_page` until it is null; a short page can still have more results.
Use [Pin Message](https://docs.onlyfansapi.com/api-reference/chat-messages/pin-message) or [Unpin Message](https://docs.onlyfansapi.com/api-reference/chat-messages/unpin-message) to change the pin state.
## OpenAPI
````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/{account}/chats/{chat_id}/messages/pinned
openapi: 3.0.3
info:
title: OnlyFans API
description: ""
version: 1.0.0
servers:
- url: https://app.onlyfansapi.com
security:
- default: []
tags:
- name: API Keys
description: ""
- name: Account
description: Endpoints for your linked accounts
- name: Analytics - Financial
description: APIs for retrieving financial analytics data
- name: Analytics - Summary
description: APIs for retrieving summary analytics data
- name: Banking
description: Operations related to user banking details, payout methods, legal
and tax information, and account country settings.
- name: Banned Words
description: Reference list of OnlyFans banned words used by the
`blockBannedWords` screening parameter
- name: Blocked / Restricted Users
description: APIs for listing the users an account has blocked or restricted
- name: Chargebacks
description: ""
- name: Chat Messages
description: ""
- name: Chats
description: ""
- name: Client Sessions
description: ""
- name: Connect OnlyFans Account
description: ""
- name: Data Exports
description: APIs for managing data exports
- name: Engagement / Messages
description: ""
- name: Fans
description: APIs for managing OnlyFans fans (subscribers)
- name: Fans - AI Summary
description: APIs for generating and retrieving AI-powered fan profile summaries
- name: Following
description: APIs for managing OnlyFans followings (people you're subscribed to)
- name: Free Trial Links
description: APIs for managing Free Trial Links. Revenue totals are net earnings
after refunds and chargebacks. `revenue.chargebacks` (or
`summary.chargebacks_total` in stats) is the positive cached net amount
already excluded from revenue; do not subtract it again. Spender responses
include chargebacks across all attributed periods for each fan with
positive net revenue.
- name: Giphy
description: ""
- name: Link Tags
description: APIs for managing tags on free trial links, tracking links, and Smart Links
- name: Mass Messaging
description: ""
- name: Media
description: ""
- name: Media Vault
description: ""
- name: Media Vault Lists
description: ""
- name: Notifications
description: Endpoints for managingr account notifications
- name: Payouts
description: ""
- name: Post Comments
description: ""
- name: Post Labels
description: APIs for managing your post labels
- name: Posts
description: APIs for managing OnlyFans posts
- name: Profile Content
description: Read another user's profile content using your connected OnlyFans
account. OnlyFans enforces subscription and purchase requirements; these
endpoints do not unlock content. Response samples use captured OnlyFans
payloads with anonymized IDs, text, and media URLs; OFAPI metadata values
are illustrative.
- name: Promotions
description: ""
- name: Public Profiles
description: ""
- name: Queue
description: ""
- name: Release Forms
description: APIs for managing OnlyFans release forms
- name: Saved For Later (Messages)
description: ""
- name: Saved For Later (Posts)
description: ""
- name: Settings
description: ""
- name: Shared Free Trial Links
description: APIs for Free Trial Links that other OF creators have shared with
this account. Revenue, cost, and spender data are not available for shared
links.
- name: Shared Tracking Links
description: APIs for Tracking Links (campaigns) that other OF creators have
shared with this account. Revenue, cost, and spender data are not
available for shared campaigns.
- name: Smart Link Postbacks
description: APIs for managing Smart Link postback destinations
- name: Smart Links
description: APIs for managing Smart Links (Free Trial Links and Tracking Links
with pooled inventory)
- name: Statistics
description: ""
- name: Stored Free Trial Links
description: Instant APIs for retrieving stored free trial links from the
OnlyFansAPI Cache (free, no credits used). `revenue.total` is net earnings
after refunds and chargebacks. `revenue.chargebacks` is the positive
cached net amount already excluded from that total; do not subtract it
again.
- name: Stored Shared Free Trial Links
description: Instant APIs for retrieving stored shared Free Trial Links from the
OnlyFansAPI Cache (free, no credits used)
- name: Stored Shared Tracking Links
description: Instant APIs for retrieving stored shared Tracking Links
(campaigns) from the OnlyFansAPI Cache (free, no credits used)
- name: Stored Tracking Links
description: Instant APIs for retrieving stored tracking links from the
OnlyFansAPI Cache (free, no credits used). `revenue.total` is net earnings
after refunds and chargebacks. `revenue.chargebacks` is the positive
cached net amount already excluded from that total; do not subtract it
again.
- name: Stories
description: APIs for managing OnlyFans stories
- name: Story Highlights
description: APIs for managing OnlyFans story highlights
- name: Subscription Bundles
description: ""
- name: Tracking Links
description: APIs for managing tracking links. Revenue totals are net earnings
after refunds and chargebacks. `revenue.chargebacks` (or
`summary.chargebacks_total` in stats) is the positive cached net amount
already excluded from revenue; do not subtract it again. Spender responses
include chargebacks across all attributed periods for each fan with
positive net revenue.
- name: Transactions
description: APIs for managing OnlyFans transactions
- name: Usage
description: Credit usage reporting for your team
- name: User List Collections
description: ""
- name: Users
description: APIs for fetching OnlyFans users
- name: Webhooks
description: ""
paths:
/api/{account}/chats/{chat_id}/messages/pinned:
parameters:
- in: path
name: account
description: The Account ID
example: acct_XXXXXXXXXXXXXXX
required: true
schema:
type: string
- in: path
name: chat_id
description: The ID of the chat (usually a fan's OnlyFans User ID)
example: "123"
required: true
schema:
type: string
get:
summary: List Pinned Chat Messages
operationId: listPinnedChatMessages
description: |-
Get pinned messages from a specific chat. Requires API-key read permission.
Returns the same message objects and pagination as [List Chat Messages](https://docs.onlyfansapi.com/api-reference/chat-messages/list-chat-messages). The pinned filter is always applied and cannot be overridden. The original `filter=pinned` listing remains supported.
Use `isPinned` for the current pin state and `canBePinned` for pin eligibility in the standard message response. Follow `_pagination.next_page` until it is null; a short page can still have more results.
Use [Pin Message](https://docs.onlyfansapi.com/api-reference/chat-messages/pin-message) or [Unpin Message](https://docs.onlyfansapi.com/api-reference/chat-messages/unpin-message) to change the pin state.
parameters:
- in: query
name: limit
description: The number of messages to return (default = 10, max = 100)
example: 10
required: false
schema:
type: string
description: The number of messages to return (default = 10, max = 100)
example: 10
- in: query
name: first_id
description: Use for pagination when `order=desc` (newest to oldest). Pass the
last message ID from the previous page to retrieve older messages,
excluding that cursor message.
example: 123
required: false
schema:
type: string
description: Use for pagination when `order=desc` (newest to oldest). Pass the
last message ID from the previous page to retrieve older messages,
excluding that cursor message.
example: 123
nullable: true
- in: query
name: last_id
description: Use for pagination when `order=asc` (oldest to newest). Include
this message ID as the first message in the results. The response is
ordered oldest first.
example: 123
required: false
schema:
type: string
description: Use for pagination when `order=asc` (oldest to newest). Include
this message ID as the first message in the results. The response
is ordered oldest first.
example: 123
nullable: true
- in: query
name: order
description: Sort order for messages (desc or asc)
example: desc
required: false
schema:
type: string
description: Sort order for messages (desc or asc)
example: desc
- in: query
name: skip_users
description: Whether to skip user details (`all` or `none`).
example: all
required: false
schema:
type: string
description: Whether to skip user details (`all` or `none`).
example: all
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
example:
data:
- responseType: message
text: Example pinned message
giphyId: null
lockedText: false
isFree: true
price: 0
isMediaReady: true
mediaCount: 0
media: []
previews: []
isTip: false
isReportedByMe: false
isCouplePeopleMedia: false
queueId: null
isMarkdownDisabled: true
releaseForms: []
fromUser:
id: 987654321
_view: s
isFromQueue: false
id: 1234567890123
isOpened: false
isNew: true
createdAt: 2025-09-02T21:02:18+00:00
changedAt: 2025-09-02T21:02:18+00:00
cancelSeconds: 0
isLiked: false
canPurchase: false
canPurchaseReason: free
canReport: false
canBePinned: true
isPinned: true
isSentByMe: true
_pagination:
next_page: https://app.onlyfansapi.com/api/acct_ANONYMIZED_ACCOUNT_ID/chats/987654321/messages/pinned?limit=10&order=desc&first_id=1234567890123
_meta:
_credits:
used: 1
balance: 224891
note: Always
_cache:
is_cached: false
note: Cache disabled for this endpoint
_rate_limits:
limit_minute: 1000
limit_day: 50000
remaining_minute: 999
remaining_day: 49984
properties:
data:
type: array
example:
- responseType: message
text: Example pinned message
giphyId: null
lockedText: false
isFree: true
price: 0
isMediaReady: true
mediaCount: 0
media: []
previews: []
isTip: false
isReportedByMe: false
isCouplePeopleMedia: false
queueId: null
isMarkdownDisabled: true
releaseForms: []
fromUser:
id: 987654321
_view: s
isFromQueue: false
id: 1234567890123
isOpened: false
isNew: true
createdAt: 2025-09-02T21:02:18+00:00
changedAt: 2025-09-02T21:02:18+00:00
cancelSeconds: 0
isLiked: false
canPurchase: false
canPurchaseReason: free
canReport: false
canBePinned: true
isPinned: true
isSentByMe: true
items:
type: object
properties:
responseType:
type: string
example: message
text:
type: string
example: Example pinned message
giphyId:
type: string
example: null
nullable: true
lockedText:
type: boolean
example: false
isFree:
type: boolean
example: true
price:
type: integer
example: 0
isMediaReady:
type: boolean
example: true
mediaCount:
type: integer
example: 0
media:
type: array
example: []
previews:
type: array
example: []
isTip:
type: boolean
example: false
isReportedByMe:
type: boolean
example: false
isCouplePeopleMedia:
type: boolean
example: false
queueId:
type: string
example: null
nullable: true
isMarkdownDisabled:
type: boolean
example: true
releaseForms:
type: array
example: []
fromUser:
type: object
properties:
id:
type: integer
example: 987654321
_view:
type: string
example: s
isFromQueue:
type: boolean
example: false
id:
type: integer
example: 1234567890123
isOpened:
type: boolean
example: false
isNew:
type: boolean
example: true
createdAt:
type: string
example: 2025-09-02T21:02:18+00:00
changedAt:
type: string
example: 2025-09-02T21:02:18+00:00
cancelSeconds:
type: integer
example: 0
isLiked:
type: boolean
example: false
canPurchase:
type: boolean
example: false
canPurchaseReason:
type: string
example: free
canReport:
type: boolean
example: false
canBePinned:
type: boolean
example: true
isPinned:
type: boolean
example: true
isSentByMe:
type: boolean
example: true
_pagination:
type: object
properties:
next_page:
type: string
example: https://app.onlyfansapi.com/api/acct_ANONYMIZED_ACCOUNT_ID/chats/987654321/messages/pinned?limit=10&order=desc&first_id=1234567890123
_meta:
type: object
properties:
_credits:
type: object
properties:
used:
type: integer
example: 1
balance:
type: integer
example: 224891
note:
type: string
example: Always
_cache:
type: object
properties:
is_cached:
type: boolean
example: false
note:
type: string
example: Cache disabled for this endpoint
_rate_limits:
type: object
properties:
limit_minute:
type: integer
example: 1000
limit_day:
type: integer
example: 50000
remaining_minute:
type: integer
example: 999
remaining_day:
type: integer
example: 49984
tags:
- Chat Messages
components:
securitySchemes:
default:
type: http
scheme: bearer
description: Get your API Key from OnlyFansAPI Console -
https://app.onlyfansapi.com/api-keys
````