---
title: "List port-out related reports"
method: GET
path: "/portouts/reports"
tags: ["Number Portout"]
---

# List port-out related reports

`GET /portouts/reports`

List the reports generated about port-out operations.

## Query parameters

- `filter` object
  - `report_type` 'export_portouts_csv' — Filter reports of a specific type
  - `status` 'pending' | 'completed' — Filter reports of a specific status
- `page[number]` integer
- `page[size]` integer

## Response `200`

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.
  - `meta` PaginationMeta
    - `total_pages` integer, required
    - `total_results` integer
    - `page_number` integer, required
    - `page_size` integer

## 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.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api/versions/e32d46c5945b/schema)