---
title: "List portout requests"
method: GET
path: "/portouts"
tags: ["Number Portout"]
---

# List portout requests

`GET /portouts`

Returns the portout requests according to filters

## Query parameters

- `page` object
  - `number` integer — The page number to load
  - `size` integer — The size of the page
- `filter` object
  - `carrier_name` string — Filter by new carrier name.
  - `pon` string — Filter by Port Order Number (PON).
  - `spid` string — Filter by new carrier spid.
  - `status` 'pending' | 'authorized' | 'ported' | 'rejected' | 'rejected-pending' | 'canceled' — Filter by portout status.
  - `status_in` string[] — Filter by a list of portout statuses
  - `country_code` string — Filter by 2-letter country code
  - `country_code_in` string[] — Filter by a list of 2-letter country codes
  - `ported_out_at` object — Filter by ported_out_at date range using nested operations
    - `gte` string, date-time — Filter by ported_out_at date greater than or equal.
    - `lte` string, date-time — Filter by ported_out_at date less than or equal.
  - `inserted_at` object — Filter by inserted_at date range using nested operations
    - `gte` string, date-time — Filter by inserted_at date greater than or equal.
    - `lte` string, date-time — Filter by inserted_at date less than or equal.
  - `foc_date` string, date-time — Filter by foc_date. Matches all portouts with the same date
  - `phone_number` string — Filter by a phone number on the portout. Matches all portouts with the phone number
  - `support_key` string — Filter by the portout's support_key

## Response `200`

Portout Response

- object
  - `data` PortoutDetails[]
    - `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` string[] — The Local Service Request
    - `pon` string — Port order number assigned by the carrier the number will be ported out to
    - `reason` string, nullable — 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` 'pending' | 'authorized' | 'ported' | 'rejected' | 'rejected-pending' | 'canceled' — Status of portout request
    - `already_ported` boolean — Is true when the number is already ported
    - `user_id` string, uuid — Identifies the user (or organization) who requested the port out
    - `vendor` string, 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
    - `host_messaging` boolean — Indicates whether messaging services should be maintained with Telnyx after the port out completes
  - `meta` Metadata
    - `total_pages` number — Total number of pages based on pagination settings
    - `total_results` number — Total number of results
    - `page_number` number — Current Page based on pagination settings (included when defaults are used.)
    - `page_size` number — Number of results to return per page based on pagination settings (included when defaults are used.)

## Other responses

- `401` — Unauthorized
- `404` — Resource not found
- `422` — Unprocessable entity. Check message field in response for details.

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/versions/8f5f4e537994/schema)