List portout requests
GET/portouts
Returns the portout requests according to filters
Request
Query Parameters
Filter by new carrier name.
Filter by new carrier spid.
Possible values: [pending
, authorized
, ported
, rejected
, rejected-pending
, canceled
]
Filter by portout status.
Possible values: >= 1
Default value: 1
The page number to load
Possible values: >= 1
and <= 250
Default value: 20
The size of the page
Responses
200: Portout Response
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
Identifies the type of the resource.
Phone numbers associated with this portout
Name of person authorizing the porting order
Carrier the number will be ported out to
The current carrier
Person name or company name requesting the port
City or municipality of billing address
State, province, or similar of billing address
Postal Code of billing address
The Local Service Request
Port order number assigned by the carrier the number will be ported out to
The reason why the order is being rejected by the user. If the order is authorized, this field can be left null
First line of billing address (street address)
ISO 8601 formatted Date/Time of the FOC date
ISO 8601 formatted Date/Time of the user requested FOC date
New service provider spid
A key to reference this port out request when contacting Telnyx customer support
Possible values: [pending
, authorized
, ported
, rejected
, rejected-pending
, canceled
]
Status of portout request
Is true when the number is already ported
Identifies the user (or organization) who requested the port out
Telnyx partner providing network coverage
ISO 8601 formatted date of when the portout was created
ISO 8601 formatted date of when the portout was created
ISO 8601 formatted date of when the portout was last updated
meta
object
Total number of pages based on pagination settings
Total number of results
Current Page based on pagination settings (included when defaults are used.)
Number of results to return per page based on pagination settings (included when defaults are used.)
{
"data": [
{
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"record_type": "portout",
"phone_numbers": [
"+35312345678"
],
"authorized_name": "McPortersen",
"carrier_name": "test",
"current_carrier": "telnyx",
"end_user_name": "McPortersen",
"city": "Chicago",
"state": "IL",
"zip": "00000",
"lsr": [
"https://example.com/files/lsr.pdf"
],
"pon": "00000000",
"reason": null,
"service_address": "000 Example Street",
"foc_date": "2018-02-02T22:25:27.521Z",
"requested_foc_date": "2018-02-02T22:25:27.521Z",
"spid": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"support_key": "PO_764725",
"status": "rejected",
"already_ported": false,
"user_id": "7865816a-ee85-4e50-b19e-52983dcc6d4a",
"vendor": "0e66ed3b-37e6-4fed-93d6-a30ce2493661",
"created_at": "2018-02-02T22:25:27.521Z",
"inserted_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"meta": {
"total_pages": 13,
"total_results": 13,
"page_number": 3,
"page_size": 1
}
}
401: Unauthorized
404: Resource not found
422: Unprocessable entity. Check message field in response for details.