Retrieve a sub number orders report

Get the status and details of a sub number orders report.

GET /sub_number_orders/report/{report_id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

const subNumberOrdersReport = await client.subNumberOrdersReport.retrieve(
  '12ade33a-21c0-473b-b055-b3c836e1c293',
);

console.log(subNumberOrdersReport.data);

200

{
  "data": {
    "order_type": "sub_number_order",
    "filters": {
      "status": "success",
      "country_code": "US",
      "created_at_gt": "2023-04-05T10:22:08.230549Z",
      "created_at_lt": "2025-06-05T10:22:08.230549Z",
      "order_request_id": "991b8ff5-4daf-4826-9a22-e3991b444a9c",
      "customer_reference": "STRING"
    },
    "status": "pending",
    "created_at": "2025-06-11T13:21:40.967339+00:00",
    "user_id": "0d7ef697-df19-413a-b724-56b0539f5397",
    "updated_at": "2025-06-11T13:21:45.753260+00:00",
    "id": "cada7e84-122b-4b47-bc66-58c7c3becd40"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

report_id · string<uuid> · required

The unique identifier of the sub number orders report

Response

200

application/json

Sub number orders report response

data · object

Show child attributes

Example:

{
  "order_type": "sub_number_order",
  "filters": {
    "status": "success",
    "country_code": "US",
    "created_at_gt": "2023-04-05T10:22:08.230549Z",
    "created_at_lt": "2025-06-05T10:22:08.230549Z",
    "order_request_id": "991b8ff5-4daf-4826-9a22-e3991b444a9c",
    "customer_reference": "STRING"
  },
  "status": "pending",
  "created_at": "2025-06-11T13:21:40.967339+00:00",
  "user_id": "0d7ef697-df19-413a-b724-56b0539f5397",
  "updated_at": "2025-06-11T13:21:45.753260+00:00",
  "id": "cada7e84-122b-4b47-bc66-58c7c3becd40"
}