Skip to main content

Get Port-In Requests

This request returns a list of port-in requests.

get /porting/port_in

Sample​

A sample GET request to get a list of port-in requests matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/core/v2/porting/port_in?limit=1' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response​

200 status code with a list of Port-In Request objects:

{
    "count": 1,
    "has_more": true,
    "items": [
        {
            "account_number": "8675309",
            "account_pin": "1234",
            "customer_address1": "123 Main St",
            "customer_address2": "",
            "customer_city": "Austin",
            "customer_company": "",
            "customer_full_name": "Jane Doe",
            "customer_state": "TX",
            "customer_zip": "78701",
            "date_created": "2026-07-01T14:32:00.000Z",
            "date_modified": "2026-07-03T09:10:00.000Z",
            "errors": [],
            "existing_service_provider": "321J",
            "gaining_service_provider": "252F",
            "loa": "https://api.carrierx.com/core/v2/storage/files/2ab7081f-db4a-42b3-b7ed-74e1019f30a6",
            "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
            "phonenumbers": ["19512623062"],
            "port_in_sid": "c7eae0b4-5eda-4964-8998-d514903b4af0",
            "requested_activation_date": null,
            "requested_effective_date": "2026-08-01T00:00:00.000Z",
            "status": "carrier_submitted"
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/porting/port_in?limit=1&offset=1"
    },
    "total": 6
}

This request is enabled for Pagination, Result Filtering, and Field Filtering.

Required Scopes​

To get information about Port-In Request objects, the partner must have one of the following scopes enabled:

  • porting.manage
  • porting.read