Skip to main content

List additional documents

GET 
/porting_orders/:id/additional_documents

Returns a list of additional documents for a porting order.

Request​

Path Parameters

    id uuidrequired

    Porting Order id

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[document_type] string

    Possible values: [loa, invoice, csr, other]

    Filter additional documents of a specific document type

    filter[document_type][in][] string[]

    Possible values: [loa, invoice, csr, other]

    Filter additional documents by a list of document types

    sort[] string

    Possible values: [created_at, -created_at]

    Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Responses​

200: Successful response

Schema

    data

    object[]

  • Array [

    • id uuid

    Uniquely identifies this additional document

    document_type string

    Possible values: [loa, invoice, csr, other]

    Identifies the type of additional document

    document_id uuid

    Identifies the associated document

    filename string

    The filename of the related document.

    content_type string

    The content type of the related document.

    porting_order_id uuid

    Identifies the associated porting order

    record_type string

    Identifies the type of the resource.

    created_at date-time

    ISO 8601 formatted date indicating when the resource was created.

    updated_at date-time

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

404: Resource not found

Request samples

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

Response samples

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