Client documents

GET /documents-clients

Retrieves metadata for client documents. Returns records only; no file content or download URL is included in the response.

This endpoint is read-only. There is no POST or PUT endpoint for client document uploads. For worker document upload and update, see Worker documents.

Example: GET /documents-clients?fromDate=2026-01-01&toDate=2026-01-31 Parameters:

Parameter	Default	Description
`fromDate`	-	Only documents created on or after this date. Format: `YYYY-MM-DD`
`toDate`	-	Only documents created on or before this date. Format: `YYYY-MM-DD`
`clientId`	-	Filter by client ID
`categoryId`	-	Filter by document category ID (from `/category-documents`). Parameter names are case-sensitive: `CategoryId` is silently ignored

Date filters apply to CreatedAt. Response:

[
  {
    "DocId": 1832,
    "ClientId": 8760,
    "DocumentName": "Care plan - 2026.pdf",
    "Note": "",
    "Protected": 0,
    "VisibleCarerMobile": 1,
    "VisibleClientMobile": 0,
    "CreatedBy": "user@example.com",
    "Category": 3,
    "CreatedAt": "2026-01-12 09:41:07"
  }
]

Response fields:

Field	Type	Notes
`DocId`	integer	Unique document record ID.
`ClientId`	integer	Client the document is attached to.
`DocumentName`	string	Original filename as uploaded.
`Note`	string	Free-text note saved with the document. Empty string if no note was entered.
`Protected`	integer	`1` if the document is marked as protected in Visualcare, otherwise `0`. Protected documents are restricted from users without the relevant permission.
`VisibleCarerMobile`	integer	`1` if the document is visible to the assigned worker in the vWorker mobile app, otherwise `0`.
`VisibleClientMobile`	integer	`1` if the document is visible to the client in the vAboutMe mobile app, otherwise `0`.
`CreatedBy`	string	Email address of the Visualcare user who uploaded the document.
`Category`	integer	Document category ID. Look up categories with `GET /category-documents`.
`CreatedAt`	string	Datetime the document was uploaded.

The response does not include file size.

Overview

Clients

Workers

Categories

Organisation

Scheduling

People

Incidents

Records

GET /documents-clients

​GET /documents-clients

GET /documents-clients