Skip to main content
GET
/
porting
/
events
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const events = await client.porting.events.list();

console.log(events.data);
{
  "data": [
    {
      "id": "eef3340b-8903-4466-b445-89b697315a3a",
      "event_type": "porting_order.deleted",
      "porting_order_id": "9471c873-e3eb-4ca1-957d-f9a451334d52",
      "available_notification_methods": [
        "email"
      ],
      "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
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

filter
object

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

Response

Successful response

data
object[]
meta
object