Skip to main content

List all porting events

GET 
/porting/events

Returns a list of all porting events.

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[type] string

    Possible values: [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.

    filter[porting_order_id] uuid

    Filter by porting order ID.

    filter[created_at][gte] date-time

    Filter by created at greater than or equal to.

    filter[created_at][lte] date-time

    Filter by created at less than or equal to.

Responses

200: Successful response

500: Internal server error

Request samples


curl -L 'https://api.telnyx.com/v2/porting/events' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


{
"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": {},
"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
}
}