v53

OpenAPI 3.1.0raw.githubusercontent.com2026-08-041,1941,9384.1 MB

Number Portout

List port-out related reports

List the reports generated about port-out operations.

get/portouts/reports

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

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

report_type'export_portouts_csv'

Filter reports of a specific type

status'pending' | 'completed'

Filter reports of a specific status

Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]

{
  "report_type": "export_portouts_csv",
  "status": "completed"
}

Response

Successful response

Example response

{
  "data": [
    {
      "created_at": "2021-03-19T10:07:15.527000Z",
      "document_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "id": "eef3340b-8903-4466-b445-89b697315a3a",
      "params": {
        "filters": {
          "customer_reference__in": [
            "my-customer-reference"
          ],
          "end_user_name": "McPortersen",
          "phone_numbers__overlaps": [
            "+1234567890"
          ]
        }
      },
      "record_type": "portout_report",
      "report_type": "export_portouts_csv",
      "status": "completed",
      "updated_at": "2021-03-19T10:07:15.527000Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}