List port-out related reports
GET/portout/reports
List the reports generated about port-out operations.
Request
Query Parameters
page[number] integer
Possible values: >= 1
Default value: 1
The page number to load
page[size] integer
Possible values: >= 1
and <= 250
Default value: 20
The size of the page
filter[report_type] string
Possible values: [export_portouts_csv
]
Filter reports of a specific type
filter[status] string
Possible values: [pending
, completed
]
Filter reports of a specific status
Responses
200: Successful response
- application/json
422: Unprocessable entity. Check message field in response for details.
500: Internal server error
Request samples
curl -L 'https://api.telnyx.com/v2/portout/reports' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Response samples
{
"data": [
{
"id": "eef3340b-8903-4466-b445-89b697315a3a",
"report_type": "export_portouts_csv",
"status": "completed",
"params": {},
"document_id": "f1486bae-f067-460c-ad43-73a92848f902",
"record_type": "portout_report",
"created_at": "2021-03-19T10:07:15.527000Z",
"updated_at": "2021-03-19T10:07:15.527000Z"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}