> ## Documentation Index
> Fetch the complete documentation index at: https://support.visualcare.com.au/llms.txt
> Use this file to discover all available pages before exploring further.

# Client documents

> Retrieve client documents with metadata including visibility and protection settings

### GET /documents-clients

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

<Note>
  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](/api-reference/workers/documents).
</Note>

**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` |

<Note>
  Filtering is limited to date range. There is no `clientId` or `categoryId` filter on this endpoint.
</Note>

**Response:**

```json theme={null}
[
  {
    "DocId": 1832,
    "ClientId": 8760,
    "DocumentName": "Care plan - 2026.pdf",
    "Note": "",
    "Protected": 0,
    "VisibleCarerMobile": 1,
    "VisibleClientMobile": 0,
    "CreatedBy": "user@example.com"
  }
]
```

**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 vClient mobile app, otherwise `0`.                                                                  |
| `CreatedBy`           | string  | Email address of the Visualcare user who uploaded the document.                                                                                         |

<Note>
  The response does not include `CategoryId`, upload date/time, or file size. To retrieve the list of available document categories, use `GET /category-documents`.
</Note>