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>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/conversations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/conversations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "error": "startDate must be before or equal to endDate",
  "code": "INVALID_DATE_RANGE"
}

{
  "error": "Unauthorized"
}

{
  "error": "Tenant-scoped keys cannot call number endpoints",
  "code": "TENANT_SCOPE_NOT_ALLOWED"
}

{
  "error": "Too many requests"
}

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

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

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pilotstatus.com.br/v1/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://pilotstatus.com.br/v1/conversations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/conversations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "error": "startDate must be before or equal to endDate",
  "code": "INVALID_DATE_RANGE"
}

{
  "error": "Unauthorized"
}

{
  "error": "Tenant-scoped keys cannot call number endpoints",
  "code": "TENANT_SCOPE_NOT_ALLOWED"
}

{
  "error": "Too many requests"
}

Endpoints

Workspace

List conversations

Authorizations

Query Parameters

Response