---
title: "List mass messages"
method: GET
path: "/chats/mass-messages"
---

# List mass messages

`GET /chats/mass-messages`

Returns a paginated list of mass (broadcast) messages sent by the authenticated creator, including delivery and engagement statistics.

Each item includes recipient count, view count, purchase count, and total revenue generated.

Use the `includeDeleted` query parameter to also retrieve deleted (unsent) mass messages. Deleted messages will have a status of `UNSENT`.

<Warning>This endpoint is only available to creators.</Warning>

## Query parameters

- `page` integer — Page number to retrieve (starts from 1)
- `size` integer — Number of items to return per page (1-50, default: 15)
- `includeDeleted` 'true' | 'false' — Whether to include deleted (unsent) mass messages in the results. Defaults to false.

## Headers

- `X-Fanvue-API-Version` string, required

## Response `200`

List of mass messages with statistics

- object
  - `data` object[], required — Array of mass messages with delivery and engagement statistics
    - `uuid` string, uuid, required
    - `text` string, nullable, required
    - `status` 'SENT' | 'UNSENT' | 'SENDING' | 'FAILED' | 'MODERATED' | 'SCHEDULED', required — Current status of the mass message
    - `price` number, nullable, required — Price in cents for pay-to-view content, or null if free
    - `createdAt` string, date, nullable, required
    - `publishedAt` string, date, nullable, required — When the message was published/sent
    - `scheduledAt` string, date, nullable, required — When the message is scheduled to send, or null for non-scheduled messages
    - `recipientCount` number, required — Number of recipients the message was sent to. 0 while the message is SCHEDULED — recipients are resolved at send time, so this only becomes final once the status leaves SCHEDULED.
    - `viewCount` number, required — Number of recipients who have viewed the message
    - `purchaseCount` number, required — Number of recipients who purchased the pay-to-view content
    - `totalRevenue` number, required — Total revenue generated from purchases of this message (in cents)
    - `mediaUuids` string[], required — Ordered list of media UUIDs attached to this mass message (display order)
    - `includedLists` object, required — Smart and custom lists the mass message was sent to. Inner arrays are empty when none were used.
      - `smartListIds` string[], required
      - `smartListUuids` string[], required — Deprecated alias of `smartListIds`. Will be removed in a future API version.
      - `customListUuids` string[], required
    - `excludedLists` object, required — Smart and custom lists excluded from the mass message. Inner arrays are empty when none were used.
      - `smartListIds` string[], required
      - `smartListUuids` string[], required — Deprecated alias of `smartListIds`. Will be removed in a future API version.
      - `customListUuids` string[], required
  - `pagination` object, required — Pagination information
    - `page` number, required — Current page number
    - `size` number, required — Number of records returned in this response
    - `hasMore` boolean, required — Whether there are more items available on subsequent pages

## Other responses

- `400` — Bad Request - API version not supported OR validation failed
- `401` — Unauthorized Response
- `403` — Unauthorized Response
- `410` — API version no longer supported (sunset)
- `429` — Too many requests - rate limit exceeded

---

[API](https://skmtc.net/fanvue/apis/fanvue-api.md) · [All operations](https://skmtc.net/fanvue/apis/fanvue-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fanvue/fanvue-api/revisions/c5ddcd5c7e72/schema)