Sign in
Order Internal Documents

List internal documents for an order

get/orders/{orderId}/internal-documents

Path parameters

orderIdnumber required

Query parameters

uploadedBynumber
Example:8

Filter by uploader user ID

searchstring
Example:registry

Search in title, original file name, and notes

sortBy'id' | 'createdAt' | 'updatedAt' | 'title' | 'originalFileName' | 'orderId'
Example:id

Field to sort by

sortType'ASC' | 'DESC'
Example:DESC

Sort direction

pagenumber required

Page number

sizenumber required
Example:10

Page size

Response

Internal documents retrieved successfully

totalItemsnumber required
pagenumber required
sizenumber required

Example response

{
  "totalItems": 25,
  "items": [
    {
      "id": 1,
      "orderId": 1302,
      "fileName": "ef9b2a52-06cb-44ac-87ec-a619d10f24a1.pdf",
      "originalFileName": "search-result.pdf",
      "filePath": "https://s3.eu-west-1.amazonaws.com/example-bucket/uploads/internal-documents/ef9b2a52-06cb-44ac-87ec-a619d10f24a1.pdf",
      "mimeType": "application/pdf",
      "fileSize": 125845,
      "uploadedBy": 8,
      "uploadedByUser": {
        "id": 8,
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@example.com"
      },
      "title": "Registry extract",
      "notes": "Re-check signatures before sharing with ops."
    }
  ],
  "size": 10
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.