v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Number Portout

List all port-out events

Returns a list of all port-out events.

get/portouts/events

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

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

event_type'portout.status_changed' | 'portout.new_comment' | 'portout.foc_date_changed'

Filter by event type.

portout_idstring uuid

Filter by port-out order ID.

Consolidated filter parameter (deepObject style). Originally: filter[event_type], filter[portout_id], filter[created_at]

{
  "created_at": {
    "gte": "2021-01-01T00:00:00Z",
    "lte": "2021-01-01T00:00:00Z"
  },
  "event_type": "portout.status_changed",
  "portout_id": "34dc46a9-53ed-4e01-9454-26227ea13326"
}

Response

Successful response

Example response

{
  "data": [
    {
      "created_at": "2021-03-19T10:07:15.527000Z",
      "event_type": "portout.status_changed",
      "id": "eef3340b-8903-4466-b445-89b697315a3a",
      "payload": {
        "attempted_pin": "1234",
        "carrier_name": "Testing Carrier",
        "id": "96dfa9e4-c753-4fd3-97cd-42d66f26cf0c",
        "phone_numbers": [
          "+35312345678"
        ],
        "spid": "987H",
        "status": "authorized",
        "subscriber_name": "John Doe",
        "user_id": "96dfa9e4-c753-4fd3-97cd-42d66f26cf0c"
      },
      "payload_status": "created",
      "portout_id": "9471c873-e3eb-4ca1-957d-f9a451334d52",
      "record_type": "portout_event",
      "updated_at": "2021-03-19T10:07:15.527000Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}