List portout requests
gethttps://api.telnyx.com/v2/portoutsReturns the portout requests according to filters
curl -X GET \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer YOUR_API_KEY" \
--globoff "https://api.telnyx.com/v2/portouts?filter[carrier_name]=string&filter[spid]=string"Parameters
In Query
filter[carrier_name]
string
optional
Filter by new carrier name.
filter[spid]
string
optional
Filter by new carrier spid.
filter[status]
string
optional
Filter by portout status.
Options: [
"pending",
"authorized",
"ported",
"rejected",
"rejected-pending",
"canceled"
]page[number]
integer
(1)optional
The page number to load
Default:
1
page[size]
integer
(1 - 250)optional
The size of the page
Default:
20
Responses
200
Portout Response
401
Unauthorized
404
Resource not found
422
Unprocessable entity. Check message field in response for details.
Success Response
{
"data": [
{
"already_ported": "boolean",
"authorized_name": "McPortersen",
"carrier_name": "test",
"city": "Chicago",
"created_at": "2018-02-02T22:25:27.521Z",
"current_carrier": "telnyx",
"end_user_name": "McPortersen",
"foc_date": "2018-02-02T22:25:27.521Z",
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"inserted_at": "2018-02-02T22:25:27.521Z",
"lsr": [
"https://example.com/files/lsr.pdf"
],
"phone_numbers": [
"+35312345678"
],
"pon": "00000000",
"reason": "string",
"record_type": "portout",
"requested_foc_date": "2018-02-02T22:25:27.521Z",
"service_address": "000 Example Street",
"spid": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"state": "IL",
"status": "rejected",
"support_key": "PO_764725",
"updated_at": "2018-02-02T22:25:27.521Z",
"user_id": "7865816a-ee85-4e50-b19e-52983dcc6d4a",
"vendor": "0e66ed3b-37e6-4fed-93d6-a30ce2493661",
"zip": "00000"
}
],
"meta": {
"page_number": 3,
"page_size": 1,
"total_pages": 13,
"total_results": 13
}
}Previous:
PortingNext:
Phone Number PortingWas this page helpful?