List supporting documents on a portout request

GET 
/portouts/:id/supporting_documents

List every supporting documents for a portout request.

Path Parameters

id uuidrequired

Portout id

201: Portout Supporting Documents

application/json

• Schema
• Example (from schema)

Schema

data

PortOutSupportingDocument[]

Array [

id uuidrequired

record_type stringrequired

Identifies the type of the resource.

type stringrequired

Possible values: [loa, invoice]

Identifies the type of the document

portout_id uuidrequired

Identifies the associated port request

document_id uuidrequired

Identifies the associated document

created_at stringrequired

Supporting document creation timestamp in ISO 8601 format

updated_at stringrequired

Supporting document last changed timestamp in ISO 8601 format

]

{
  "data": [
    {
      "id": "5a16902a-2ee9-4882-a247-420fc6627b62",
      "record_type": "supporting_document",
      "type": "loa",
      "portout_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      "document_id": "f1c5e079-9d82-4f50-95bc-ae2f6b8d84d7",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ]
}

401: Unauthorized

404: Resource not found

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/portouts/:id/supporting_documents' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 201

---

{
  "data": [
    {
      "id": "5a16902a-2ee9-4882-a247-420fc6627b62",
      "record_type": "supporting_document",
      "type": "loa",
      "portout_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      "document_id": "f1c5e079-9d82-4f50-95bc-ae2f6b8d84d7",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ]
}