Conversations

Unread messages

Lists the linked number’s unread INBOUND messages (newest first). “total” is the TRUE unread count — the sum of Conversation.unreadCount (the same counter the dashboard shows), not a raw count of inbound messages. Each item carries conversationUnreadCount (the conversation’s unread total). Paginated via page/pageSize (no date range). The number’s privacy (PII) mode applies: RELAY_ONLY → [] + notice:“PII_RELAY_ONLY”; STORE_X_DAYS clamps to the retention window. Requires a number-scoped key.

Requires a number-scoped key.

GET

messages

unread

Unread messages

curl --request GET \
  --url https://pilotstatus.com.br/v1/messages/unread \
  --header 'x-api-key: <api-key>'

{
  "messages": [
    {
      "id": "cm_01HZX...",
      "conversationId": "conv_01HZX...",
      "direction": "INBOUND",
      "from": "+5511988887777",
      "fromName": "Ana",
      "userId": "BR.13491208655302741918",
      "username": "ana",
      "text": "Olá, ainda está disponível?",
      "createdAt": "2026-06-27T10:00:00.000Z",
      "readAt": null,
      "conversationUnreadCount": 3
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Query Parameters

page

string

Page (default 1). (integer (≥1))

pageSize

string

Items per page (default 30, max 100). (integer (1–100))

Response

Unread messages

Message history

List groups

⌘I

Unread messages

curl --request GET \
  --url https://pilotstatus.com.br/v1/messages/unread \
  --header 'x-api-key: <api-key>'

{
  "messages": [
    {
      "id": "cm_01HZX...",
      "conversationId": "conv_01HZX...",
      "direction": "INBOUND",
      "from": "+5511988887777",
      "fromName": "Ana",
      "userId": "BR.13491208655302741918",
      "username": "ana",
      "text": "Olá, ainda está disponível?",
      "createdAt": "2026-06-27T10:00:00.000Z",
      "readAt": null,
      "conversationUnreadCount": 3
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}