---
title: "List all porting events"
method: GET
path: "/porting/events"
tags: ["Porting Orders"]
---

# List all porting events

`GET /porting/events`

Returns a list of all porting events.

## Query parameters

- `page` object
  - `number` integer — The page number to load
  - `size` integer — The size of the page
- `filter` object
  - `created_at` object — Created at date range filtering 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.
  - `porting_order_id` string, uuid — Filter by porting order ID.
  - `type` 'porting_order.deleted' | 'porting_order.loa_updated' | 'porting_order.messaging_changed' | 'porting_order.status_changed' | 'porting_order.sharing_token_expired' | 'porting_order.new_comment' | 'porting_order.split' — Filter by event type.

## Response `200`

Successful response

- object
  - `data` PortingEvent[]
    - union
      - object
        - `available_notification_methods` string[] — Indicates the notification methods used.
        - `event_type` 'porting_order.deleted' — Identifies the event type
        - `id` string, uuid — Uniquely identifies the event.
        - `payload` object
          - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
          - `customer_reference` string — Identifies the customer reference associated with the porting order.
          - `deleted_at` string, date-time — ISO 8601 formatted date indicating when the porting order was deleted.
          - `id` string, uuid — Identifies the porting order that was deleted.
          - `record_type` string — Identifies the type of the resource.
          - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.
        - `payload_status` 'created' | 'completed' — The status of the payload generation.
        - `porting_order_id` string, uuid — Identifies the porting order associated with the event.
      - object
        - `available_notification_methods` string[] — Indicates the notification methods used.
        - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
        - `event_type` 'porting_order.messaging_changed' — Identifies the event type
        - `id` string, uuid — Uniquely identifies the event.
        - `payload` object — The webhook payload for the porting_order.messaging_changed event
          - `customer_reference` string — Identifies the customer reference associated with the porting order.
          - `id` string, uuid — Identifies the porting order that was moved.
          - `messaging` object — The messaging portability status of the porting order.
            - `enable_messaging` boolean — Indicates whether Telnyx will port messaging capabilities from the losing carrier. If false, any messaging capabilities will stay with their current provider.
            - `messaging_capable` boolean — Indicates whether the porting order is messaging capable.
            - `messaging_port_completed` boolean — Indicates whether the messaging port is completed.
            - `messaging_port_status` 'not_applicable' | 'pending' | 'activating' | 'exception' | 'canceled' | 'partial_port_complete' | 'ported' — Indicates the messaging port status of the porting order.
          - `support_key` string — Identifies the support key associated with the porting order.
        - `payload_status` 'created' | 'completed' — The status of the payload generation.
        - `porting_order_id` string, uuid — Identifies the porting order associated with the event.
        - `record_type` string — Identifies the type of the resource.
        - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.
      - object
        - `available_notification_methods` string[] — Indicates the notification methods used.
        - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
        - `event_type` 'porting_order.status_changed' — Identifies the event type
        - `id` string, uuid — Uniquely identifies the event.
        - `payload` object — The webhook payload for the porting_order.status_changed event
          - `customer_reference` string — Identifies the customer reference associated with the porting order.
          - `id` string, uuid — Identifies the porting order that was moved.
          - `status` PortingOrderStatus — Porting order status
            - `details` PortingOrdersExceptionType[] — A list of 0 or more details about this porting order's status
              - …
            - `value` 'draft' | 'in-process' | 'submitted' | 'exception' | 'foc-date-confirmed' | 'ported' | 'cancelled' | 'cancel-pending' — The current status of the porting order
          - `support_key` string — Identifies the support key associated with the porting order.
          - `updated_at` string, date-time — ISO 8601 formatted date indicating when the porting order was moved.
          - `webhook_url` string — The URL to send the webhook to.
        - `payload_status` 'created' | 'completed' — The status of the payload generation.
        - `porting_order_id` string, uuid — Identifies the porting order associated with the event.
        - `record_type` string — Identifies the type of the resource.
        - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.
      - object
        - `available_notification_methods` string[] — Indicates the notification methods used.
        - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
        - `event_type` 'porting_order.new_comment' — Identifies the event type
        - `id` string, uuid — Uniquely identifies the event.
        - `payload` object — The webhook payload for the porting_order.new_comment event
          - `comment` object — The comment that was added to the porting order.
            - `body` string — The body of the comment.
            - `id` string, uuid — Identifies the comment.
            - `inserted_at` string, date-time — ISO 8601 formatted date indicating when the comment was created.
            - `user_id` string, uuid — Identifies the user that create the comment.
            - `user_type` 'user' | 'admin' | 'system' — Identifies the type of the user that created the comment.
          - `porting_order_id` string, uuid — Identifies the porting order that the comment was added to.
          - `support_key` string — Identifies the support key associated with the porting order.
        - `payload_status` 'created' | 'completed' — The status of the payload generation.
        - `porting_order_id` string, uuid — Identifies the porting order associated with the event.
        - `record_type` string — Identifies the type of the resource.
        - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.
      - object
        - `available_notification_methods` string[] — Indicates the notification methods used.
        - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
        - `event_type` 'porting_order.split' — Identifies the event type
        - `id` string, uuid — Uniquely identifies the event.
        - `payload` object — The webhook payload for the porting_order.split event
          - `from` object — The porting order that was split.
            - `id` string, uuid — Identifies the porting order that was split.
          - `porting_phone_numbers` object[] — The list of porting phone numbers that were moved to the new porting order.
            - `id` string, uuid — Identifies the porting phone number that was moved.
          - `to` object — The new porting order that the phone numbers was moved to.
            - `id` string, uuid — Identifies the porting order that was split.
        - `payload_status` 'created' | 'completed' — The status of the payload generation.
        - `porting_order_id` string, uuid — Identifies the porting order associated with the event.
        - `record_type` string — Identifies the type of the resource.
        - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.
      - object
        - `available_notification_methods` string[] — Indicates the notification methods used.
        - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
        - `event_type` 'porting_order.loa_updated' | 'porting_order.sharing_token_expired' — Identifies the event type
        - `id` string, uuid — Uniquely identifies the event.
        - `payload` unknown
        - `payload_status` 'created' | 'completed' — The status of the payload generation.
        - `porting_order_id` string, uuid — Identifies the porting order associated with the event.
        - `record_type` string — Identifies the type of the resource.
        - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.
  - `meta` PaginationMeta
    - `page_number` integer
    - `page_size` integer
    - `total_pages` integer
    - `total_results` integer

## Other responses

- `422` — Unprocessable entity. Check the 'detail' 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/revisions/1571b0380bd7/schema)