ListClientDocumentsResponse
successboolean
Example:
truedata object[]
Array [
idstring<uuid>
Unique document identifier.
clientIdstring<uuid>
Client UUID this document belongs to.
fileNamestring
Original file name uploaded by the merchant.
contentTypestring
MIME type of the uploaded document.
fileSizeinteger
Size of the uploaded file in bytes.
urlstring<uri>
Public URL of the stored file in Basilic Blob storage.
pathnamestring
Internal blob pathname used for lifecycle operations.
descriptionstringnullable
Optional merchant-provided description for this document.
createdAtstring<date-time>
When the document record was created.
]
pagination object
pageintegerrequired
Current page number
Example:
1limitintegerrequired
Items per page
Example:
20totalintegerrequired
Total number of items
Example:
150totalPagesintegerrequired
Total number of pages
Example:
8timestampstring<date-time>
ListClientDocumentsResponse
{
"success": true,
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fileName": "string",
"contentType": "string",
"fileSize": 0,
"url": "string",
"pathname": "string",
"description": "string",
"createdAt": "2024-07-29T15:51:28.071Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 150,
"totalPages": 8
},
"timestamp": "2024-07-29T15:51:28.071Z"
}