Skip to main content
GET
/
porting_orders
/
{id}
/
requirements
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 portingOrderRetrieveRequirementsResponse of client.portingOrders.retrieveRequirements(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingOrderRetrieveRequirementsResponse.field_type);
}
{
  "data": [
    {
      "field_type": "document",
      "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
      "requirement_type": {
        "acceptance_criteria": {
          "acceptable_values": []
        },
        "description": "A copy of the latest phone bill from the current provider",
        "example": "Most recent phone bill",
        "id": "53970723-fbff-4f46-a975-f62be6c1a585",
        "name": "Latest Invoice",
        "type": "document"
      },
      "requirement_status": "approved",
      "record_type": "porting_requirement"
    }
  ],
  "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.

Path Parameters

​
id
string<uuid>
required

Porting Order id

Query Parameters

​
page
object

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

Response

Successful response

​
data
object[]
​
meta
object