Mass Messages

Get Mass Message

Returns the latest snapshot of a single queue item — sent or still-scheduled. Same per-item fetch the OnlyFans web app uses when opening a queue row. Useful for refreshing a single row's sentCount / viewedCount without re-listing the whole queue, or for reading back the text/media/scheduledDate of a scheduled message before editing it. Requires permission api_mass_messages_read.

https://public-api.fansmetric.com

GET/v1/{account_id}/mass-messages/queue/{queue_id}

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.
queue_id*integer
The queue ID of the mass message to fetch.

Response Fields

data.successboolean
Whether the upstream lookup succeeded.
data.queueobject
The queue item snapshot.
data.queue.idinteger
Queue ID.
data.queue.datestring
Send/scheduled timestamp (ISO 8601).
data.queue.textstring
Message text (HTML).
data.queue.textCroppedstring
Cropped preview text used in list rows.
data.queue.giphyIdstring | null
Giphy ID if the message is a GIF.
data.queue.isFreeboolean
Whether the message is free (no paywall).
data.queue.sentCountinteger
Recipients delivered to so far.
data.queue.viewedCountinteger
Recipients who have opened the message.
data.queue.canUnsendboolean
Whether the message can still be cancelled.
data.queue.unsendSecondsinteger
Seconds remaining in the unsend window.
data.queue.isCanceledboolean
True if the message has been cancelled.
data.queue.hasErrorboolean
True if sending errored.
data.queue.mediaTypesarray | null
Media-type summary if media is attached.
data.queue.releaseFormsarray
Release forms attached to the media, if any.
dataobject | array
Endpoint-specific payload. See the fields below for this route.
_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.success	boolean	Whether the upstream lookup succeeded.
data.queue	object	The queue item snapshot.
data.queue.id	integer	Queue ID.
data.queue.date	string	Send/scheduled timestamp (ISO 8601).
data.queue.text	string	Message text (HTML).
data.queue.textCropped	string	Cropped preview text used in list rows.
data.queue.giphyId	string \| null	Giphy ID if the message is a GIF.
data.queue.isFree	boolean	Whether the message is free (no paywall).
data.queue.sentCount	integer	Recipients delivered to so far.
data.queue.viewedCount	integer	Recipients who have opened the message.
data.queue.canUnsend	boolean	Whether the message can still be cancelled.
data.queue.unsendSeconds	integer	Seconds remaining in the unsend window.
data.queue.isCanceled	boolean	True if the message has been cancelled.
data.queue.hasError	boolean	True if sending errored.
data.queue.mediaTypes	array \| null	Media-type summary if media is attached.
data.queue.releaseForms	array	Release forms attached to the media, if any.
data	object \| array	Endpoint-specific payload. See the fields below for this route.
_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/mass-messages/queue/sample_queue_id" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"success":true
"queue":{"id":123
"date":"2026-06-05T12:00:00+00:00"
"text":"VIP drop tomorrow"
"giphyId":null
"textCropped":"VIP drop tomorrow"
"isFree":true
"sentCount":0
"viewedCount":0
"canUnsend":true
"unsendSeconds":60
"isCanceled":false
"mediaTypes":null
"hasError":false
"releaseForms":[]
}
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

List Mass Message Queue

List Mass Message Buyers