Skip to main content
GET
/
porting
/
reports
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const portingReport of client.porting.reports.list()) {
  console.log(portingReport.id);
}
{
  "data": [
    {
      "id": "eef3340b-8903-4466-b445-89b697315a3a",
      "report_type": "export_porting_orders_csv",
      "status": "completed",
      "params": {
        "filters": {
          "status__in": [
            "draft"
          ],
          "customer_reference__in": [
            "my-customer-reference"
          ],
          "created_at__lt": "2023-11-07T05:31:56Z",
          "created_at__gt": "2023-11-07T05:31:56Z"
        }
      },
      "document_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "record_type": "porting_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
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
object

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

​
filter
object

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

Response

Successful response

​
data
object[]
​
meta
object