Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Porting Orders

List all porting orders

Returns a list of your porting order.

get/porting_orders

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

include_phone_numbersboolean

Include the first 50 phone number objects in the results

customer_group_referencestring

Filter results by customer_group_reference

customer_referencestring

Filter results by customer_reference

parent_support_keystring

Filter results by parent_support_key

Consolidated filter parameter (deepObject style). Originally: filter[customer_reference], filter[customer_group_reference], filter[parent_support_key], filter[phone_numbers.country_code], filter[phone_numbers.carrier_name], filter[misc.type], filter[end_user.admin.entity_name], filter[end_user.admin.auth_person_name], filter[activation_settings.fast_port_eligible], filter[activation_settings.foc_datetime_requested][gt], filter[activation_settings.foc_datetime_requested][lt], filter[phone_numbers.phone_number][contains]

{
  "activation_settings": {
    "foc_datetime_requested": {
      "gt": "2021-03-25T10:00:00.000Z",
      "lt": "2021-03-25T10:00:00.000Z"
    }
  },
  "misc": {
    "type": "full"
  }
}
value'created_at' | '-created_at' | 'activation_settings.foc_datetime_requested' | '-activation_settings.foc_datetime_requested'

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

Consolidated sort parameter (deepObject style). Originally: sort[value]

{
  "value": "created_at"
}

Response

Successful response

Example 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_group_reference": "Group-456",
      "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_status": "pending"
      },
      "misc": {
        "remaining_numbers_action": "disconnect",
        "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": "local",
      "phone_numbers": [
        {
          "activation_status": "Active",
          "phone_number": "13035550987",
          "phone_number_type": "local",
          "portability_status": "confirmed",
          "porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
          "porting_order_status": "in-process",
          "record_type": "porting_phone_number",
          "requirements_status": "approved",
          "support_key": "sr_a12345"
        }
      ],
      "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"
        }
      ],
      "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
  }
}