Phone & voice · Phone Numbers
Returns port-in orders.
GET
https://api.pozy.ai/v1/phone-numbers/port-inlistPhoneNumberPortIns
Guides: Port a number in, Phone numbers
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication
Example
curl -X GET "https://api.pozy.ai/v1/phone-numbers/port-in" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/phone-numbers/port-in", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/phone-numbers/port-in",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
ordersarray of object11 child fields
idstringstatusstringOne of
draft,pending,foc_confirmed,ported,exception,cancelled.carrierStatusValuestringCan be null.
phoneNumbersarray of stringfastPortEligiblebooleanCan be null.
focDatetimeRequestedstring (date-time)Can be null.
focDatetimeActualstring (date-time)Can be null.
declineReasonstringCan be null.
submittedAtstring (date-time)Can be null.
portedAtstring (date-time)Can be null.
createdAtstring (date-time)
200 response
{
"orders": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"status": "draft",
"carrierStatusValue": "active",
"phoneNumbers": [
"+14155550123"
],
"fastPortEligible": true,
"focDatetimeRequested": "2026-10-02T09:00:00.000Z",
"focDatetimeActual": "2026-10-02T09:00:00.000Z",
"declineReason": "string",
"submittedAt": "2026-10-02T09:00:00.000Z",
"portedAt": "2026-10-02T09:00:00.000Z",
"createdAt": "2026-10-02T09:00:00.000Z"
}
]
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in Phone Numbers
GETList phone numbersGETGet phone numberDELRelease phone numberPOSTPurchase phone numberGETResolve a number claimGETList offerable number countriesGETSearch available numbersGETCheck country availabilityGETGet KYC form specPOSTSubmit KYCGETView a KYC document on filePOSTUpload a KYC documentPOSTPre-validate KYC addressPOSTCreate a hosted KYC linkPOSTPort numbers inPOSTCheck portabilityGETResolve a port claimPOSTUpload a porting documentGETCountry porting requirementsGETA port-in order's pending requirementsDELCancel a port-inPOSTPre-review a KYC packetGETGet declined requirementsPOSTResubmit a declined numberPOSTReply to the regulatory reviewerPOSTRespond to the regulatory reviewer (message + corrections)GETList stock watchesPOSTWatch an out-of-stock countryDELStop watching a countryPOSTRequest the WhatsApp verification code for a number