Client documents

GET /documents-clients

Retrieves all client documents.

This is a read-only endpoint. There’s no POST endpoint for client document uploads (unlike worker documents).

Parameters:

Parameter	Default	Description
`fromDate`	-	Documents from date. Format: `YYYY-MM-DD`
`toDate`	-	Documents before date. Format: `YYYY-MM-DD`

Example response:

[
  {
    "DocId": 1705,
    "ClientId": 4472,
    "DocumentName": "MyCareConnect_User Guide Mob April 2020.pdf",
    "Note": "",
    "Protected": 0,
    "VisibleCarerMobile": 0,
    "VisibleClientMobile": 0,
    "CreatedBy": "user@example.com"
  }
]

Response fields:

Field	Type	Notes
`DocId`	integer
`ClientId`	integer
`DocumentName`	string
`Note`	string
`Protected`	integer	0/1
`VisibleCarerMobile`	integer	0/1
`VisibleClientMobile`	integer	0/1
`CreatedBy`	string	Email

No clientId filter parameter is documented. No categoryId filter. Filtering is limited to date range only. No file download or content retrieval endpoint exists.

Client compliance

Expenses

⌘I

Overview

Clients

Workers

Categories

Organisation

Scheduling

People

Incidents

Records

GET /documents-clients

​GET /documents-clients

GET /documents-clients