Skip to main content
List conversations for the connected number, ordered by the most recent message activity.

​
Endpoint

GET https://pilotstatus.com.br/v1/conversations
Requires a number-scoped API key (ps_*) in the x-api-key header. Tenant-scoped keys return 403.

​
Query parameters

​
string
ISO 8601 datetime. Filter conversations whose last message is on or after this date.
​
string
ISO 8601 datetime. Filter conversations whose last message is on or before this date.
​
integer
default:"1"
Page number (≥ 1).
​
integer
default:"30"
Results per page (1–100).
Both startDate and endDate are optional individually. When supplied, each must be a valid ISO 8601 string and startDate must not be later than endDate; otherwise 400 INVALID_DATE_RANGE is returned.

​
PII mode effect

The response depends on the PII mode configured for the number — changed in the dashboard on the API Keys page (Privacy & retention panel) or on the number’s settings in Numbers:

​
Example

​
Conversation object fields

​
string
required
Pilot Status conversation ID.
​
string
required
"DIRECT", "GROUP" or "NEWSLETTER".
​
string | null
Sender phone in E.164 (with +) for individuals; null for groups/newsletters and lid-only peers.
​
string | null
Contact or group display name when available (resolved from the conversation).
​
string
required
ISO 8601 — timestamp of the last message activity.
​
integer
required
Number of inbound messages not yet read.
​
string
required
ISO 8601 — when the conversation was first created.

​
Common errors

  • 400 INVALID_DATE_RANGE — startDate or endDate is not a valid ISO 8601 string, or startDate > endDate.
  • 400 NUMBER_NOT_FOUND — the API key is not bound to a WhatsApp number.
  • 401 — missing or invalid x-api-key header.
  • 403 — tenant-scoped key used (number-scoped key required).