---
title: "List all port-out events"
method: GET
path: "/portouts/events"
tags: ["Number Portout"]
---

# List all port-out events

`GET /portouts/events`

Returns a list of all port-out events.

## Query parameters

- `page` object
  - `number` integer — The page number to load
  - `size` integer — The size of the page
- `filter` object
  - `event_type` 'portout.status_changed' | 'portout.new_comment' | 'portout.foc_date_changed' — Filter by event type.
  - `portout_id` string, uuid — Filter by port-out order ID.
  - `created_at` object — Filter by created_at date range using nested operations
    - `gte` string, date-time — Filter by created at greater than or equal to.
    - `lte` string, date-time — Filter by created at less than or equal to.

## Response `200`

Successful response

- object
  - `data` PortoutEvent[]
    - union
      - object
        - `id` string, uuid — Uniquely identifies the event.
        - `event_type` 'portout.status_changed' | 'portout.foc_date_changed' | 'portout.new_comment' — Identifies the event type
        - `portout_id` string, uuid — Identifies the port-out order associated with the event.
        - `available_notification_methods` string[] — Indicates the notification methods used.
        - `payload_status` 'created' | 'completed' — The status of the payload generation.
        - `payload` object — The webhook payload for the portout.status_changed event
          - `id` string, uuid — Identifies the port out that was moved.
          - `status` 'pending' | 'authorized' | 'ported' | 'rejected' | 'rejected-pending' | 'canceled' — The new status of the port out.
          - `phone_numbers` string[] — Phone numbers associated with this port-out order
          - `carrier_name` string — Carrier the number will be ported out to
          - `spid` string — The new carrier SPID.
          - `user_id` string, uuid — Identifies the user that the port-out order belongs to.
          - `subscriber_name` string — The name of the port-out's end user.
          - `rejection_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
          - `attempted_pin` string — The PIN that was attempted to be used to authorize the port out.
        - `record_type` string — Identifies the type of the resource.
        - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
        - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.
      - object
        - `id` string, uuid — Uniquely identifies the event.
        - `event_type` 'portout.status_changed' | 'portout.foc_date_changed' | 'portout.new_comment' — Identifies the event type
        - `portout_id` string, uuid — Identifies the port-out order associated with the event.
        - `available_notification_methods` string[] — Indicates the notification methods used.
        - `payload_status` 'created' | 'completed' — The status of the payload generation.
        - `payload` object — The webhook payload for the portout.new_comment event
          - `id` string, uuid — Identifies the comment that was added to the port-out order.
          - `portout_id` string, uuid — Identifies the port-out order that the comment was added to.
          - `user_id` string, uuid — Identifies the user that added the comment.
          - `comment` string — The body of the comment.
        - `record_type` string — Identifies the type of the resource.
        - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
        - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.
      - object
        - `id` string, uuid — Uniquely identifies the event.
        - `event_type` 'portout.status_changed' | 'portout.foc_date_changed' | 'portout.new_comment' — Identifies the event type
        - `portout_id` string, uuid — Identifies the port-out order associated with the event.
        - `available_notification_methods` string[] — Indicates the notification methods used.
        - `payload_status` 'created' | 'completed' — The status of the payload generation.
        - `payload` object — The webhook payload for the portout.foc_date_changed event
          - `id` string, uuid — Identifies the port-out order that have the FOC date changed.
          - `user_id` string — Identifies the organization that port-out order belongs to.
          - `foc_date` string, date-time — ISO 8601 formatted date indicating the new FOC date.
        - `record_type` string — Identifies the type of the resource.
        - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
        - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.
  - `meta` PaginationMeta
    - `total_pages` integer
    - `total_results` integer
    - `page_number` integer
    - `page_size` integer

## Other responses

- `422` — Unprocessable entity. Check message field in response for details.
- `500` — Internal server error

---

[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)