Skip to main content
GET
List mass messages
Required scope
  • read:chat — Read chat conversations, messages, and chat-related data. This includes viewing chat lists and message history.

Authorizations

Authorization
string
header
required

OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.

Headers

X-Fanvue-API-Version
string
default:2025-06-26
required

API version to use for the request

Example:

"2025-06-26"

Query Parameters

page
number
default:1

Page number to retrieve (starts from 1)

Required range: x >= 1
size
number
default:15

Number of items to return per page (1-50, default: 15)

Required range: 1 <= x <= 50
includeDeleted
enum<string>
default:false

Whether to include deleted (unsent) mass messages in the results. Defaults to false.

Available options:
true,
false

Response

List of mass messages with statistics

data
object[]
required

Array of mass messages with delivery and engagement statistics

pagination
object
required

Pagination information