Conversations

List conversations

Lists the linked number’s conversations, ordered by last activity (lastMessageAt desc). Paginated via page/pageSize. Filter by date with startDate/endDate (ISO 8601, over lastMessageAt). The number’s privacy (PII) mode affects the response: RELAY_ONLY returns [] + notice:“PII_RELAY_ONLY”; STORE_X_DAYS clamps to the window max(startDate, now − retentionDays). Requires a number-scoped key. Contact identity: from is the E.164 phone (with +) when known — it may be null for contacts using a WhatsApp username; userId is the durable BSUID (stable contact id) and username the public handle when visible.

Requires a number-scoped key.

GET

conversations

List conversations

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

{
  "conversations": [
    {
      "id": "conv_01HZX...",
      "from": "+5511988887777",
      "fromName": "Ana",
      "userId": "BR.13491208655302741918",
      "username": "ana",
      "type": "DIRECT",
      "unreadCount": 2,
      "lastMessageAt": "2026-06-27T10:00:00.000Z",
      "lastMessagePreview": "Olá! Sua entrega chegou."
    }
  ],
  "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 lastMessageAt). Must be ≤ endDate. (string (ISO 8601))

endDate

string

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

page

string

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

pageSize

string

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

Response

List conversations

Cancel scheduled messages

Group messages

⌘I

List conversations

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

{
  "conversations": [
    {
      "id": "conv_01HZX...",
      "from": "+5511988887777",
      "fromName": "Ana",
      "userId": "BR.13491208655302741918",
      "username": "ana",
      "type": "DIRECT",
      "unreadCount": 2,
      "lastMessageAt": "2026-06-27T10:00:00.000Z",
      "lastMessagePreview": "Olá! Sua entrega chegou."
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 30,
  "totalPages": 1
}