Skip to main content
GET
/
portouts
/
reports
/
{id}
JavaScript
import Telnyx from 'telnyx';

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

const report = await client.portouts.reports.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(report.data);
{
  "data": {
    "id": "eef3340b-8903-4466-b445-89b697315a3a",
    "report_type": "export_portouts_csv",
    "status": "completed",
    "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"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Identifies a report.

Response

Successful response

​
data
object