Developers
Sign in
Create an AccountSign inQuestions on setup? Talk to our experts

List all porting orders

gethttps://api.telnyx.com/v2/porting_orders

Returns a list of your porting order.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/porting_orders?page[number]=1&page[size]=20"

Parameters

In Query
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
include_phone_numbers
boolean
optional
Include the first 50 phone number objects in the results
Default:
true
filter[status]
string
optional
Filter results by status
Example: "in-process"Options: [ "draft", "in-process", "submitted", "exception", "foc-date-confirmed", "cancel-pending", "ported", "cancelled" ]
filter[status][in][]
string
optional
Filter porting orders by multiple statuses
Example: "in-process"Options: [ "draft", "in-process", "submitted", "exception", "foc-date-confirmed", "cancel-pending", "ported", "cancelled" ]
filter[customer_reference]
string
optional
Filter results by user reference
Example: "123abc"
filter[phone_numbers.country_code]
string
optional
Filter results by country ISO 3166-1 alpha-2 code
Example: "US"
filter[phone_numbers.carrier_name]
string
optional
Filter results by old service provider
Example: "Telnyx"
filter[misc.type]
string
optional
Filter results by porting order type
Example: "full"Options: [ "full", "partial" ]
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
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"
sort[]
string
optional
Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
Example: "created_at"Options: [ "created_at", "-created_at", "activation_settings.foc_datetime_requested", "-activation_settings.foc_datetime_requested" ]

Responses

200
Successful response
401
Unauthorized
422
Unprocessable entity. Check message field in response for details.

Success Response

{
  "data": [
    {
      "activation_settings": {
        "activation_status": "Active",
        "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": "IL",
          "country_code": "US",
          "extended_address": "Suite 504",
          "locality": "Chicago",
          "postal_code": "60654",
          "street_address": "311 W. Superior St"
        }
      },
      "id": "f1486bae-f067-460c-ad43-73a92848f902",
      "misc": {
        "new_billing_phone_number": "string",
        "remaining_numbers_action": "disconnect",
        "type": "full"
      },
      "old_service_provider_ocn": "Unreal Communications",
      "parent_support_key": "pr_123abc",
      "phone_number_configuration": {
        "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": "local",
      "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": "boolean",
      "status": {
        "details": [
          {
            "code": "ENTITY_NAME_MISMATCH",
            "description": "Entity name does not match that on the CSR"
          }
        ],
        "value": "ported"
      },
      "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
  }
}

...

posthttps://api.telnyx.com/v2/porting_orders

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/porting_orders/exception_types

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/porting_orders/{id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/porting_orders/{id}

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/porting_orders/{id}

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/porting_orders/{id}/activation_jobs

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/porting_orders/{id}/activation_jobs/{activationJobId}

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/porting_orders/{id}/loa_template

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/porting_orders/{id}/actions/confirm

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/porting_orders/{id}/actions/cancel

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/porting_orders/{id}/actions/activate

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/porting_orders/{id}/allowed_foc_windows

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/porting_orders/{id}/requirements

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/porting_phone_numbers

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/porting_orders/{id}/sub_request

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/porting_orders/{id}/comments

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/porting_orders/{id}/comments

...

...

Parameters

Responses

Success Response

Previous:
Phone Number Porting
Next:
Number Lookup
Was this page helpful?