v52

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

Create a port-out related report

Generate reports about port-out operations.

post/portouts/reports

Request body

report_type'export_portouts_csv' required

Identifies the type of report

Example request

{
  "params": {
    "filters": {
      "customer_reference__in": [
        "my-customer-reference"
      ],
      "end_user_name": "McPortersen",
      "phone_numbers__overlaps": [
        "+1234567890"
      ]
    }
  },
  "report_type": "export_portouts_csv"
}

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"
  }
}