Numbers
List numbers
Lists every WhatsApp number on the tenant (PILOT_STATUS and Meta Cloud API), including connection state and API key prefixes. Authenticate with x-api-key-id (or x-api-key: ps_…).
GET
/
v1
/
numbers
List numbers
curl --request GET \
--url https://pilotstatus.com.br/v1/numbers \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/numbers"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/numbers', 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/numbers",
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/numbers"
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))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/numbers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/numbers")
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[
{
"id": "num_01HZX...",
"instanceName": "tenant-5511999999999",
"number": "5511999999999",
"name": "Suporte",
"provider": "PILOT_STATUS",
"apiKeys": [
{
"name": "Default",
"keyPrefix": "ps_abcd",
"keyLast4": "wxyz"
}
],
"state": "OPEN",
"isFullyConnected": true,
"createdAt": "2026-06-01T11:59:00.000Z",
"updatedAt": "2026-06-01T12:00:00.000Z"
}
]{
"error": "Unauthorized"
}{
"error": "Too many requests"
}Authorizations
apiKeyapiKeyId
Your ps_ API key
Response
List numbers
Was this page helpful?
⌘I
List numbers
curl --request GET \
--url https://pilotstatus.com.br/v1/numbers \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/numbers"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/numbers', 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/numbers",
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/numbers"
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))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/numbers")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/numbers")
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[
{
"id": "num_01HZX...",
"instanceName": "tenant-5511999999999",
"number": "5511999999999",
"name": "Suporte",
"provider": "PILOT_STATUS",
"apiKeys": [
{
"name": "Default",
"keyPrefix": "ps_abcd",
"keyLast4": "wxyz"
}
],
"state": "OPEN",
"isFullyConnected": true,
"createdAt": "2026-06-01T11:59:00.000Z",
"updatedAt": "2026-06-01T12:00:00.000Z"
}
]{
"error": "Unauthorized"
}{
"error": "Too many requests"
}