Mass Messaging
Get Mass Message Overview
Get an overview of mass messages, showing the send count and view count.
get/api/{account}/mass-messaging/overview
Query parameters
startDatestring
The earliest mass message to retrieve. Keep empty to get all.
Example:2025-01-01 00:00:00
The earliest mass message to retrieve. Keep empty to get all.
endDatestring
The latest mass message to retrieve. Keep empty to get all. MUST BE DATE AFTER startDate. This is also used for pagination.
Example:2025-03-31 23:59:59
The latest mass message to retrieve. Keep empty to get all. MUST BE DATE AFTER startDate. This is also used for pagination.
limitinteger
Number of mass messages to return (default = 10)
Example:10
Number of mass messages to return (default = 10)
querystring
Optionally, find a mass message by the message text.
Example:My message text
Optionally, find a mass message by the message text.
Response
Example response
{
"data": {
"hasMore": true,
"items": [
{
"id": 123,
"date": "2025-01-01T01:01:01+01:01",
"responseType": "message",
"text": "<p>Text</p>",
"rawText": "<p>Text</p>",
"giphyId": null,
"isFree": true,
"isMediaReady": true,
"mediaCount": 1,
"media": [
{
"id": 123,
"type": "photo",
"convertedToVideo": false,
"canView": true,
"hasError": false,
"createdAt": "2025-01-01T01:01:01+01:01",
"isReady": true,
"files": {
"full": {
"url": "https://cdn2.onlyfans.com/files/.../image.jpg",
"width": 2335,
"height": 4175,
"size": 0,
"sources": []
},
"thumb": {
"url": "https://cdn2.onlyfans.com/files/.../image.jpg",
"width": 300,
"height": 300,
"size": 0
},
"preview": {
"url": "https://cdn2.onlyfans.com/files/.../image.jpg",
"width": 960,
"height": 1717,
"size": 0
},
"squarePreview": {
"url": "https://cdn2.onlyfans.com/files/.../image.jpg",
"width": 960,
"height": 960,
"size": 0
}
},
"duration": 0,
"hasCustomPreview": false,
"videoSources": {
"240": null,
"720": null
}
}
],
"previews": [],
"isTip": false,
"isReportedByMe": false,
"viewedCount": 123,
"sentCount": 123,
"isCanceled": false,
"template": "group",
"canUnsend": true,
"unsendSeconds": 1000000
}
]
},
"_meta": {
"_credits": {
"used": 1,
"balance": 999999959,
"note": "Always"
},
"_cache": {
"is_cached": false,
"note": "Cache disabled for this endpoint"
},
"_rate_limits": {
"limit_minute": 1000,
"limit_day": 50000,
"remaining_minute": 998,
"remaining_day": 49988
}
}
}