Phone Number Orders

Retrieve a sub number orders report

Changed on

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

get/sub_number_orders_report/{report_id}

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/sub_number_orders_report/{report_id}
  • Auth
    HTTP bearer

Path parameters

report_idstring uuid required

The unique identifier of the sub number orders report

Response

Sub number orders report response

Example response

{
  "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"
  }
}

Changes

  • 67df31283a8aRevision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a72569d69430Revision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status