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

const client = new Telnyx({
  apiKey: 'My API Key',
});

const additionalDocuments = await client.portingOrders.additionalDocuments.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(additionalDocuments.data);
{
  "data": [
    {
      "id": "2acd1061-33cb-49b8-8014-beb6dc3fedbf",
      "document_id": "40bc547a-7f96-4cd5-926a-da4842671e88",
      "document_type": "loa",
      "porting_order_id": "9d7b3b8e-4e67-4837-9c44-d110cd2c82a1",
      "record_type": "porting_additional_document",
      "created_at": "2023-06-01T10:00:00.00000Z",
      "updated_at": "2023-06-01T10:00:00.00000Z"
    }
  ],
  "meta": {
    "total_pages": 1,
    "total_results": 1,
    "page_number": 1,
    "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]

filter
object

Consolidated filter parameter (deepObject style). Originally: filter[document_type]

sort
object

Consolidated sort parameter (deepObject style). Originally: sort[value]

Response

Successful response

data
object[]
meta
object