Conversations

Group messages

Lists messages in the linked number’s GROUP conversations (newest first). Paginated via page/pageSize. Filter by date with startDate/endDate (ISO 8601, over createdAt). Meta numbers return 400 NOT_SUPPORTED_FOR_META (groups are PILOT_STATUS-only). The number’s privacy (PII) mode applies: RELAY_ONLY → [] + notice:“PII_RELAY_ONLY”; STORE_X_DAYS clamps to the window max(startDate, now − retentionDays). Requires a number-scoped key.

Requires a number-scoped key.

GET

messages

group

Group messages

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

{
  "messages": [
    {
      "id": "cm_01HZX...",
      "conversationId": "conv_01HZX...",
      "groupId": "123456789-987654321@g.us",
      "groupSubject": "Pilot Status Group",
      "direction": "INBOUND",
      "fromNumber": "5511988887777",
      "text": "Bom dia, pessoal!",
      "createdAt": "2026-06-27T10:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Query Parameters

startDate

string

Start of the date range (filters by createdAt). Must be ≤ endDate. (string (ISO 8601))

endDate

string

End of the date range (filters by createdAt). (string (ISO 8601))

page

string

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

pageSize

string

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

Response

Group messages

List conversations

Message history

⌘I

Group messages

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

{
  "messages": [
    {
      "id": "cm_01HZX...",
      "conversationId": "conv_01HZX...",
      "groupId": "123456789-987654321@g.us",
      "groupSubject": "Pilot Status Group",
      "direction": "INBOUND",
      "fromNumber": "5511988887777",
      "text": "Bom dia, pessoal!",
      "createdAt": "2026-06-27T10:00:00.000Z"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}