Skip to content
/Documents

List client documents

Request

Returns document file names and time-limited download URLs (S3 pre-signed) for a client. Requires Document Manager View permission scoped to the client module. When dot is provided, the API validates that the DOT is set on the client and that the caller has access (same pattern as GET /v1/clients).

Security
BearerAuth and ApiKeyAuth
Query
clientIdinteger, >= 1required

Client ID.

dotstring

Optional DOT number; when set, must match the specified client and your access.

curl -i -X GET \
  'https://docs.meshvi.com/_mock/apis/meshvi/v1/documents/clients?clientId=1&dot=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'apiKey: YOUR_API_KEY_HERE'

Responses

Wrapped result: success true with data listing documents, or success false (e.g. no documents) with error text — still HTTP 200.

Bodyapplication/json
successboolean
dataArray of objects(DocumentDownloadReference)
errorstring
Response
{
  "success": true,
  "data": [
    { … }
  ],
  "error": "string"
}