Skip to documentation
GETBearer token

List messages

/api/v1/messages

Read organization messages and unread count, 8 messages per page.

Request example

cURL
curl "https://tovahub.com/api/v1/messages?page=1" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

Examples only. No requests are sent from this page.

Illustrative response
JSON
{
  "userId": "507f1f77bcf86cd799439013",
  "through": "2026-11-07T12:00:00.000Z",
  "messages": [],
  "unreadCount": 0,
  "page": 1,
  "pageSize": 8,
  "totalCount": 0,
  "totalPages": 1
}

Parameters

pageQuery · Optional

string

Positive integer represented as a query string; defaults to "1". Use totalPages for navigation.

Response

HTTP status 200

Read page-number-paginated organization messages.

userIdstring (ObjectId)

Authenticated user identifier.

throughstring (ISO 8601)

Snapshot cutoff to pass to mark_messages_read.

messagesarray

Projected message rows; does not include serverId or dedupeKey.

messages[]._idstring (ObjectId)

Message identifier.

messages[].ticketIdstring (ObjectId) | null

Associated support ticket identifier, if present.

messages[].typestring

server_expiring, server_expired, renewal_failed, balance_gift, admin_message, or ticket_reply.

messages[].serverNamestring | null

Associated server name, if present.

messages[].expiresAtstring (ISO 8601) | null

Associated service expiry, if present.

messages[].daysLeftnumber | null

Remaining-days notification value, if present.

messages[].amountstring | null

Notification amount, if present.

messages[].messagestring | null

Message body, if present.

messages[].readAtstring (ISO 8601) | null

Read time, or null.

messages[].createdAtstring (ISO 8601)

Message creation time.

unreadCountnumber

Unread message count across the organization.

pagenumber

Effective page number, clamped to the available pages.

pageSizenumber (8)

Fixed page size.

totalCountnumber

Total message count.

totalPagesnumber

Total pages; at least one even for an empty list.