List all porting orders

GET

/porting_orders

Porting Orders

Returns a list of your porting order.

Response Example

{
    "data": [
        {
            "activation_settings": {
                "activation_status": "New",
                "fast_port_eligible": true,
                "foc_datetime_actual": "2021-03-19T10:07:15.527Z",
                "foc_datetime_requested": "2021-03-19T10:07:15.527Z"
            },
            "created_at": "2021-03-19T10:07:15.527Z",
            "customer_reference": "Acct 123abc",
            "description": "FP Telnyx",
            "documents": {
                "invoice": "ce74b771-d23d-4960-81ec-8741b3862146",
                "loa": "64ffb720-04c7-455b-92d6-20fcca92e935"
            },
            "end_user": {
                "admin": {
                    "account_number": "123abc",
                    "auth_person_name": "Porter McPortersen II",
                    "billing_phone_number": 13035551234,
                    "business_identifier": "abc123",
                    "entity_name": "Porter McPortersen",
                    "pin_passcode": 1234,
                    "tax_identifier": "1234abcd"
                },
                "location": {
                    "administrative_area": "TX",
                    "country_code": "US",
                    "extended_address": "14th Floor",
                    "locality": "Austin",
                    "postal_code": "78701",
                    "street_address": "600 Congress Avenue"
                }
            },
            "id": "f1486bae-f067-460c-ad43-73a92848f902",
            "messaging": {
                "enable_messaging": true,
                "messaging_capable": true,
                "messaging_port_completed": false,
                "messaging_port_status": "not_applicable"
            },
            "misc": {
                "new_billing_phone_number": "string",
                "remaining_numbers_action": "keep",
                "type": "full"
            },
            "old_service_provider_ocn": "Unreal Communications",
            "parent_support_key": "pr_123abc",
            "phone_number_configuration": {
                "billing_group_id": "f1486bae-f067-460c-ad43-73a92848f902",
                "connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
                "emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
                "messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
                "tags": [
                    "abc",
                    "123"
                ]
            },
            "phone_number_type": "landline",
            "porting_phone_numbers_count": 1,
            "record_type": "porting_order",
            "requirements": [
                {
                    "field_type": "document",
                    "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
                    "record_type": "porting_requirement",
                    "requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66"
                }
            ],
            "requirements_met": false,
            "status": {
                "details": [
                    {
                        "code": "ACCOUNT_NUMBER_MISMATCH",
                        "description": "Entity name does not match that on the CSR"
                    }
                ],
                "value": "draft"
            },
            "support_key": "sr_123abc",
            "updated_at": "2021-03-19T10:07:15.527Z",
            "user_feedback": {
                "user_comment": "I loved my experience porting numbers with Telnyx",
                "user_rating": 5
            },
            "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
            "webhook_url": "https://example.com/porting_webhooks"
        }
    ],
    "meta": {
        "page_number": 2,
        "page_size": 25,
        "total_pages": 3,
        "total_results": 55
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

page[number]

integer

optional

The page number to load

>= 1

Default:

page[size]

integer

optional

The size of the page

>= 1<= 250

Default:

include_phone_numbers

boolean

optional

Include the first 50 phone number objects in the results

Default:

true

filter[status]

enum<string>

optional

Filter results by status

Allowed values:

draftin-processsubmittedexceptionfoc-date-confirmedcancel-pendingportedcancelled

Example:

in-process

filter[status][in][]

enum<string>

optional

Filter porting orders by multiple statuses

Allowed values:

draftin-processsubmittedexceptionfoc-date-confirmedcancel-pendingportedcancelled

Example:

in-process

filter[customer_reference]

string

optional

Filter results by customer_reference

Example:

123abc

filter[parent_support_key]

string

optional

Filter results by parent_support_key

Example:

123abc

filter[phone_numbers.country_code]

string

optional

Filter results by country ISO 3166-1 alpha-2 code

Example:

filter[phone_numbers.carrier_name]

string

optional

Filter results by old service provider

Example:

Telnyx

filter[misc.type]

enum<string>

optional

Filter results by porting order type

Allowed values:

fullpartial

Example:

full

filter[end_user.admin.entity_name]

string

optional

Filter results by person or company name

Example:

Porter McPortersen

filter[end_user.admin.auth_person_name]

string

optional

Filter results by authorized person

Example:

Admin McPortersen

filter[activation_settings.fast_port_eligible]

boolean

optional

Filter results by fast port eligible

Example:

false

filter[activation_settings.foc_datetime_requested][gt]

string

optional

Filter results by foc date later than this value

Example:

2021-03-25T10:00:00.000Z

filter[activation_settings.foc_datetime_requested][lt]

string

optional

Filter results by foc date earlier than this value

Example:

2021-03-25T10:00:00.000Z

filter[phone_numbers.phone_number][contains]

string

optional

Filter results by full or partial phone_number

Example:

+13038675309

sort[]

enum<string>

optional

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Allowed values:

created_at-created_atactivation_settings.foc_datetime_requested-activation_settings.foc_datetime_requested

Example:

created_at

Responses

🟢200OK

application/json

Successful response

Body

data

array[object (PortingOrder) {23}]

optional

activation_settings

object (PortingOrderActivationSettings)

optional

created_at

string <date-time>

read-onlyoptional

ISO 8601 formatted date indicating when the resource was created.

Example:

2021-03-19T10:07:15.527Z

customer_reference

string

optional

A customer-specified reference number for customer bookkeeping purposes

Example:

Acct 123abc

description

string

read-onlyoptional

A description of the porting order

Example:

FP Telnyx

documents

object (PortingOrderDocuments)

optional

Can be specified directly or via the requirement_group_id parameter.

end_user

object (PortingOrderEndUser)

optional

string <uuid>

read-onlyoptional

Uniquely identifies this porting order

Example:

f1486bae-f067-460c-ad43-73a92848f902

messaging

object (PortingOrderMessaging)

optional

Information about messaging porting process.

misc

object (PortingOrderMisc)

optional

old_service_provider_ocn

string

read-onlyoptional

Identifies the old service provider

Example:

Unreal Communications

parent_support_key

string

read-onlyoptional

A key to reference for the porting order group when contacting Telnyx customer support. This information is not available for porting orders in draft state

Example:

pr_123abc

phone_number_configuration

object (PortingOrderPhoneNumberConfiguration)

optional

phone_number_type

enum<string>

optional

The type of the phone number

Allowed values:

landlinelocalmobilenationalshared_costtoll_free

Example:

local

porting_phone_numbers_count

integer

read-onlyoptional

Count of phone numbers associated with this porting order

Example:

record_type

string

read-onlyoptional

Identifies the type of the resource.

Example:

porting_order

requirements

array[object (PortingOrderRequirement) {4}]

optional

List of documentation requirements for porting numbers. Can be set directly or via the requirement_group_id parameter.

requirements_met

boolean

optional

Is true when the required documentation is met

Example:

false

status

object (PortingOrderStatus)

optional

Porting order status

support_key

string

read-onlyoptional

A key to reference this porting order when contacting Telnyx customer support. This information is not available in draft porting orders.

Example:

sr_123abc

updated_at

string <date-time>

read-onlyoptional

ISO 8601 formatted date indicating when the resource was created.

Example:

2021-03-19T10:07:15.527Z

user_feedback

object (PortingOrderUserFeedback)

optional

user_id

string <uuid>

optional

Identifies the user (or organization) who requested the porting order

Example:

40d68ba2-0847-4df2-be9c-b0e0cb673e75

webhook_url

string <uri>

optional

Example:

https://example.com/porting_webhooks