Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB
Porting Orders

List all porting events

Returns a list of all porting events.

get/porting/events

Query parameters

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.

porting_order_idstring uuid

Filter by porting order ID.

Consolidated filter parameter (deepObject style). Originally: filter[type], filter[porting_order_id], filter[created_at][gte], filter[created_at][lte]

{
  "type": "porting_order.deleted",
  "porting_order_id": "34dc46a9-53ed-4e01-9454-26227ea13326",
  "created_at": {
    "gte": "2021-01-01T00:00:00Z",
    "lte": "2021-01-01T00:00:00Z"
  }
}
page[number]integer
page[size]integer

Response

Successful response

Example response

{
  "data": [
    {
      "id": "eef3340b-8903-4466-b445-89b697315a3a",
      "event_type": "porting_order.deleted",
      "porting_order_id": "9471c873-e3eb-4ca1-957d-f9a451334d52",
      "payload_status": "created",
      "payload": {
        "id": "96dfa9e4-c753-4fd3-97cd-42d66f26cf0c",
        "customer_reference": "my-ref-001",
        "deleted_at": "2021-03-19T10:07:15.527Z",
        "record_type": "porting_event",
        "created_at": "2021-03-19T10:07:15.527000Z",
        "updated_at": "2021-03-19T10:07:15.527000Z"
      }
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}