List phone lines
Returns the lines of the key’s workspace, newest purchase first. By default only the lines you still hold (ACTIVE, PAYMENT_PENDING, SUSPENDED); add includeClosed=true to include the finished ones (RETURNED, CANCELED). The list is not paginated: it always returns every matching line. Each item is the same line object GET /v1/phone-lines/{id} returns.
Permissions: with an OAuth / MCP token, the user must be an Owner or Admin (phone_lines:read) — 403 PERMISSION_DENIED otherwise.
Every /v1/phone-lines endpoint takes a tenant-scoped key only: a line belongs to the workspace, not to a WhatsApp number, so a number-scoped key (or a per-number OAuth grant) gets 403 NUMBER_SCOPE_NOT_ALLOWED before any role is looked at. A 403 PERMISSION_DENIED / WORKSPACE_MEMBERSHIP_REQUIRED is sent with Cache-Control: no-store.
Requires a tenant-scoped key.
curl --request GET \
--url https://pilotstatus.com.br/v1/phone-lines \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines"
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/phone-lines', 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/phone-lines",
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/phone-lines"
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/phone-lines")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines")
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{
"lines": [
{
"id": "cmg5k2l1n0001pl8example9x",
"name": "Support SP",
"number": "551148637200",
"display": "(11) 4863-7200",
"ddd": "11",
"status": "ACTIVE",
"price": 33.9,
"currency": "BRL",
"purchasedAt": "2026-10-01T14:03:11.000Z",
"currentPeriodEnd": "2026-11-01T14:03:11.000Z",
"cancelAtPeriodEnd": false,
"paymentPendingSince": null,
"suspendedAt": null,
"returnedAt": null,
"canceledAt": null,
"activationCount": 1,
"amountDue": null
}
]
}Authorizations
Your ps_ API key
Query Parameters
true or 1 includes finished lines (RETURNED, CANCELED); false, 0 or absent leaves them out. Any other value (case-sensitive: TRUE is refused) → 400 INVALID_QUERY.
true, false, 1, 0 Response
The workspace's lines, newest purchase first
The lines, newest purchase first. Not paginated.
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://pilotstatus.com.br/v1/phone-lines \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/phone-lines"
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/phone-lines', 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/phone-lines",
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/phone-lines"
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/phone-lines")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/phone-lines")
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{
"lines": [
{
"id": "cmg5k2l1n0001pl8example9x",
"name": "Support SP",
"number": "551148637200",
"display": "(11) 4863-7200",
"ddd": "11",
"status": "ACTIVE",
"price": 33.9,
"currency": "BRL",
"purchasedAt": "2026-10-01T14:03:11.000Z",
"currentPeriodEnd": "2026-11-01T14:03:11.000Z",
"cancelAtPeriodEnd": false,
"paymentPendingSince": null,
"suspendedAt": null,
"returnedAt": null,
"canceledAt": null,
"activationCount": 1,
"amountDue": null
}
]
}