v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Porting Orders

List additional documents

Returns a list of additional documents for a porting order.

get/porting_orders/{id}/additional_documents

Path parameters

idstring uuid required

Porting Order id

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

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

document_typestring[]

Filter additional documents by a list of document types

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

{
  "document_type": [
    "loa"
  ]
}

value'created_at' | '-created_at'

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

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

{
  "value": "created_at"
}

Response

Successful response

Example response

{
  "data": [
    {
      "created_at": "2023-06-01T10:00:00.00000Z",
      "document_id": "40bc547a-7f96-4cd5-926a-da4842671e88",
      "document_type": "loa",
      "id": "2acd1061-33cb-49b8-8014-beb6dc3fedbf",
      "porting_order_id": "9d7b3b8e-4e67-4837-9c44-d110cd2c82a1",
      "record_type": "porting_additional_document",
      "updated_at": "2023-06-01T10:00:00.00000Z"
    }
  ],
  "meta": {
    "page_number": 1,
    "page_size": 25,
    "total_pages": 1,
    "total_results": 1
  }
}