Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Number Portout

List portout requests

Returns the portout requests according to filters

get/portouts

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

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

carrier_namestring

Filter by new carrier name.

country_codestring

Filter by 2-letter country code

country_code_instring[]

Filter by a list of 2-letter country codes

foc_datestring date-time

Filter by foc_date. Matches all portouts with the same date

phone_numberstring

Filter by a phone number on the portout. Matches all portouts with the phone number

ponstring

Filter by Port Order Number (PON).

spidstring

Filter by new carrier spid.

status'pending' | 'authorized' | 'ported' | 'rejected' | 'rejected-pending' | 'canceled'

Filter by portout status.

status_instring[]

Filter by a list of portout statuses

support_keystring

Filter by the portout's support_key

Consolidated filter parameter (deepObject style). Originally: filter[carrier_name], filter[country_code], filter[country_code_in], filter[foc_date], filter[inserted_at], filter[phone_number], filter[pon], filter[ported_out_at], filter[spid], filter[status], filter[status_in], filter[support_key]

{
  "country_code": "US",
  "country_code_in": [
    "CA",
    "US"
  ],
  "foc_date": "2024-09-04T00:00:00.000Z",
  "inserted_at": {
    "gte": "2024-09-04T00:00:00.000Z",
    "lte": "2024-09-04T00:00:00.000Z"
  },
  "phone_number": "+13035551212",
  "ported_out_at": {
    "gte": "2024-09-04T00:00:00.000Z",
    "lte": "2024-09-04T00:00:00.000Z"
  },
  "support_key": "PO_abc123"
}

Response

Portout Response

Example response

{
  "data": [
    {
      "authorized_name": "McPortersen",
      "carrier_name": "test",
      "city": "Chicago",
      "created_at": "2018-02-02T22:25:27.521Z",
      "current_carrier": "telnyx",
      "end_user_name": "McPortersen",
      "foc_date": "2018-02-02T22:25:27.521Z",
      "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      "inserted_at": "2018-02-02T22:25:27.521Z",
      "lsr": [
        "https://example.com/files/lsr.pdf"
      ],
      "phone_numbers": [
        "+35312345678"
      ],
      "pon": "00000000",
      "record_type": "portout",
      "rejection_code": 1002,
      "requested_foc_date": "2018-02-02T22:25:27.521Z",
      "service_address": "000 Example Street",
      "spid": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      "state": "IL",
      "status": "rejected",
      "support_key": "PO_764725",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "user_id": "7865816a-ee85-4e50-b19e-52983dcc6d4a",
      "vendor": "0e66ed3b-37e6-4fed-93d6-a30ce2493661",
      "zip": "00000"
    }
  ],
  "meta": {
    "page_number": 3,
    "page_size": 1,
    "total_pages": 13,
    "total_results": 13
  }
}