Skip to main content

List all porting phone numbers

GET 
/porting_phone_numbers

Returns a list of your porting phone numbers.

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[porting_order_id] uuid

    Filter results by porting order id

    filter[porting_order_id][in][] uuid[]

    Filter results by a list of porting order ids

    filter[support_key][eq] string

    Filter results by support key

    filter[support_key][in][] string[]

    Filter results by a list of support keys

    filter[phone_number] string

    Filter results by phone number

    filter[phone_number][in][] string[]

    Filter results by a list of phone numbers

    filter[porting_order_status] string

    Possible values: [draft, in-process, submitted, exception, foc-date-confirmed, cancel-pending, ported, cancelled]

    Filter results by porting order status

    filter[activation_status] PortingOrderActivationStatus

    Possible values: [New, Pending, Conflict, Cancel Pending, Failed, Concurred, Activate RDY, Disconnect Pending, Concurrence Sent, Old, Sending, Active, Cancelled]

    Filter results by activation status

    filter[portability_status] PortabilityStatus

    Possible values: [pending, confirmed, provisional]

    Filter results by portability status

Responses

200: Successful response

401: Unauthorized

422: Unprocessable entity. Check message field in response for details.

Request samples


curl -L 'https://api.telnyx.com/v2/porting_phone_numbers' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


{
"data": [
{
"porting_order_status": "in-process",
"phone_number_type": "local",
"phone_number": 13035550987,
"porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
"support_key": "sr_a12345",
"activation_status": "Active",
"portability_status": "confirmed",
"requirements_status": "approved",
"record_type": "porting_phone_number"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}