---
title: "Create a port-out related report"
method: POST
path: "/portouts/reports"
tags: ["Number Portout"]
---

# Create a port-out related report

`POST /portouts/reports`

Generate reports about port-out operations.

## Request body

- object — The parameters for generating a new port-out related report.
  - `report_type` 'export_portouts_csv', required — Identifies the type of report
  - `params` ExportPortoutsCSVReport, required — The parameters for generating a port-outs CSV report.
    - `filters` object, required — The filters to apply to the export port-out CSV report.
      - `status__in` string[] — The status of the port-outs to include in the report.
      - `customer_reference__in` string[] — The customer reference of the port-outs to include in the report.
      - `end_user_name` string — The end user name of the port-outs to include in the report.
      - `phone_numbers__overlaps` string[] — A list of phone numbers that the port-outs phone numbers must overlap with.
      - `created_at__lt` string, date-time — The date and time the port-out was created before.
      - `created_at__gt` string, date-time — The date and time the port-out was created after.

## Response `201`

Successful response

- object
  - `data` PortoutReport
    - `id` string, uuid — Uniquely identifies the report.
    - `report_type` 'export_portouts_csv' — Identifies the type of report
    - `status` 'pending' | 'completed' — The current status of the report generation.
    - `params` ExportPortoutsCSVReport — The parameters for generating a port-outs CSV report.
      - `filters` object, required — The filters to apply to the export port-out CSV report.
        - `status__in` string[] — The status of the port-outs to include in the report.
        - `customer_reference__in` string[] — The customer reference of the port-outs to include in the report.
        - `end_user_name` string — The end user name of the port-outs to include in the report.
        - `phone_numbers__overlaps` string[] — A list of phone numbers that the port-outs phone numbers must overlap with.
        - `created_at__lt` string, date-time — The date and time the port-out was created before.
        - `created_at__gt` string, date-time — The date and time the port-out was created after.
    - `document_id` string, uuid — Identifies the document that was uploaded when report was generated. This field is only populated when the report is under completed status.
    - `record_type` string — Identifies the type of the resource.
    - `created_at` string, date-time — ISO 8601 formatted date indicating when the resource was created.
    - `updated_at` string, date-time — ISO 8601 formatted date indicating when the resource was updated.

## Other responses

- `422` — Unprocessable entity. Check message field in response for details.
- `500` — Internal server error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/versions/8f5f4e537994/schema)