Skip to main content

List portout requests

GET 
/portouts

Returns the portout requests according to filters

Request ​

Query Parameters

    filter[carrier_name] string

    Filter by new carrier name.

    filter[spid] string

    Filter by new carrier spid.

    filter[status] string

    Possible values: [pending, authorized, ported, rejected, rejected-pending, canceled]

    Filter by portout status.

    filter[status_in] string[]

    Possible values: [pending, authorized, ported, rejected, rejected-pending, canceled]

    Filter by a list of portout statuses

    filter[ported_out_at][gte] date-time

    Filter by ported_out_at date greater than or equal.

    filter[ported_out_at][lte] date-time

    Filter by ported_out_at date less than or equal.

    filter[inserted_at][gte] date-time

    Filter by inserted_at date greater than or equal.

    filter[inserted_at][lte] date-time

    Filter by inserted_at date less than or equal.

    filter[foc_date] date-time

    Filter by foc_date. Matches all portouts with the same date

    filter[phone_number] string

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

    filter[support_key] string

    Filter by the portout's support_key

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses ​

200: Portout Response

Schema

    data

    object[]

  • Array [

    • id string
    record_type string

    Identifies the type of the resource.

    phone_numbers string[]

    Phone numbers associated with this portout

    authorized_name string

    Name of person authorizing the porting order

    carrier_name string

    Carrier the number will be ported out to

    current_carrier string

    The current carrier

    end_user_name string

    Person name or company name requesting the port

    city string

    City or municipality of billing address

    state string

    State, province, or similar of billing address

    zip string

    Postal Code of billing address

    lsr uri[]

    The Local Service Request

    pon string

    Port order number assigned by the carrier the number will be ported out to

    reason string

    The reason why the order is being rejected by the user. If the order is authorized, this field can be left null

    rejection_code integer

    The rejection code for one of the valid rejections to reject a port out order

    service_address string

    First line of billing address (street address)

    foc_date string

    ISO 8601 formatted Date/Time of the FOC date

    requested_foc_date string

    ISO 8601 formatted Date/Time of the user requested FOC date

    spid string

    New service provider spid

    support_key string

    A key to reference this port out request when contacting Telnyx customer support

    status string

    Possible values: [pending, authorized, ported, rejected, rejected-pending, canceled]

    Status of portout request

    already_ported boolean

    Is true when the number is already ported

    user_id uuid

    Identifies the user (or organization) who requested the port out

    vendor uuid

    Telnyx partner providing network coverage

    created_at string

    ISO 8601 formatted date of when the portout was created

    inserted_at string

    ISO 8601 formatted date of when the portout was created

    updated_at string

    ISO 8601 formatted date of when the portout was last updated

  • ]

    • meta

    object

    total_pages double

    Total number of pages based on pagination settings

    total_results double

    Total number of results

    page_number double

    Current Page based on pagination settings (included when defaults are used.)

    page_size double

    Number of results to return per page based on pagination settings (included when defaults are used.)

401: Unauthorized

404: Resource not found

422: Unprocessable entity. Check message field in response for details.

Request samples

curl -L 'https://api.telnyx.com/v2/portouts' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

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