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

# Client information

> Retrieve client profile data including demographics, contact details, health information, and preferences

The Visualcare public API provides a range of client-related endpoints covering core profile data, agreements, Home Care Package (HCP) statements, DEX cases, contacts, compliance, documents, expenses, groups, and notes.

All endpoints in this section are read-only (GET).

### GET /clients

Retrieves all clients. By default, deleted and non-current clients are excluded.

**Example:** `GET /clients?clientId=8760&includeDEX=TRUE&includeHealth=TRUE`

**Parameters:**

| Parameter           | Default | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clientId`          | -       | If set to numeric ID, returns a single client                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `includeDeleted`    | -       | If `TRUE`, returns deleted clients                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `includeNonCurrent` | -       | If `TRUE`, returns non-current clients                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `serviceStatus`     | -       | Returns clients matching this status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `serviceStart`      | -       | Returns clients with service start date >= value. Format: `YYYY-MM-DD`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `serviceEnd`        | -       | Returns clients with service start date \<= value. Format: `YYYY-MM-DD`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `includeNotes`      | -       | If `TRUE`, returns: `NotesRisk`, `NotesAlert`, `NotesGeneral`, `NotesRoster`, `NotesClientProfile`, `NotesShiftAlert`                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `includeVulnerable` | -       | If `TRUE`, returns: `Vulnerable`, `VulnerableFire`, `VulnerableHeat`, `VulnerableFlood`, `VulnerablePower`, `VulnerableStateRegistered`, `VulnerableFinancial`, `VulnerableWeatherEvents`, `VulnerableReason`                                                                                                                                                                                                                                                                                                                                                        |
| `includeHealth`     | -       | If `TRUE`, returns: `PrimaryDisability`, `SecondaryDisability`, `AssociatedDisability`, `MedicalConditions`, `MobilityLevel`, `ManualHandling`, `DiagnosedDisability`, `VisionImpaired`, `SpeechImpaired`, `HearingImpaired`, `UndiagnosedDisability`, `DisabilitySupportPension`, `Mobility`, `Dementia`, `VulnerableClient`, `VulnerableStateRegistered`, `VulnerableHeat`, `VulnerableReason`, `ComplexNeeds`, `ManagementPlan`, `ManagementPlanType`, `MedicationAdmin`, `MedicationPrompt`, `MedicationNote`, `SelfAdministered`, `Diagnosis`, `HealthCareCard` |
| `includePref`       | -       | If `TRUE`, returns: `PrefGender`, `PrefNonSmoker`, `PrefPet`, `PrefLanguages`, `PrefCultures`, `PrefInterests`, `PrefSkills`, `PrefTraining`, `PrefAdditional`                                                                                                                                                                                                                                                                                                                                                                                                       |
| `includeDex`        | -       | If `TRUE`, returns: `DexClientId`, `Slk`, `PlaceOfBirth`, `LivingCircumstances`, `HomelessIndicatorCode`, `HasDisabilities`, `DisabilityCode`                                                                                                                                                                                                                                                                                                                                                                                                                        |

**Base response fields:**

| Field                  | Type        | Notes           |
| ---------------------- | ----------- | --------------- |
| `ClientId`             | integer     |                 |
| `ClientCode`           | string      |                 |
| `FirstName`            | string      |                 |
| `MiddleName`           | string      |                 |
| `LastName`             | string      |                 |
| `PreferredName`        | string      |                 |
| `Gender`               | string      |                 |
| `FundingType`          | string      |                 |
| `ClientType`           | string/null |                 |
| `Address1`             | string      |                 |
| `Address2`             | string      |                 |
| `Suburb`               | string      |                 |
| `State`                | string      |                 |
| `PostCode`             | string      |                 |
| `Longitude`            | string      |                 |
| `Latitude`             | string      |                 |
| `Email`                | string      |                 |
| `Phone1`               | string      |                 |
| `Phone2`               | string      |                 |
| `PhoneSMS`             | string      |                 |
| `Fax`                  | string      |                 |
| `ContactPref`          | string      |                 |
| `DateOfBirth`          | string      | Date format     |
| `PayerId`              | integer     |                 |
| `Area`                 | string      |                 |
| `Division`             | string      |                 |
| `Group`                | string      |                 |
| `CaseManager`          | string      | Email format    |
| `CaseManager2`         | string      | Email format    |
| `MaritalStatus`        | string      |                 |
| `Aboriginal`           | integer     | 0/1             |
| `TorresStraitIslander` | integer     | 0/1             |
| `LGBQTI`               | integer     | 0/1             |
| `LanguageEnglish`      | integer     | 0/1             |
| `LanguageOther`        | string      |                 |
| `InterpreterRequired`  | integer     | 0/1             |
| `ClientNo`             | string      |                 |
| `AccountingCode`       | string      |                 |
| `MedicareNo`           | string      |                 |
| `AmbulanceNo`          | string      |                 |
| `Weight`               | integer     |                 |
| `Height`               | integer     |                 |
| `DVA`                  | string      |                 |
| `TSI`                  | integer     | 0/1             |
| `ATSI`                 | integer     | 0/1             |
| `CALD`                 | integer     | 0/1             |
| `CHSP`                 | integer     | 0/1             |
| `SATSS`                | integer     | 0/1             |
| `HCPLevel`             | integer     |                 |
| `LiveAlone`            | integer     | 0/1             |
| `SingleWorker`         | integer     | 0/1             |
| `CompanionCard`        | string      |                 |
| `PrivateHealth`        | string      |                 |
| `LegalOrders`          | string      |                 |
| `LivingArrangement`    | string      |                 |
| `EmploymentType`       | string      |                 |
| `Referral`             | integer     | 0/1             |
| `Referer`              | string      |                 |
| `RefererCode`          | string      |                 |
| `MACCode`              | string      |                 |
| `MyAgedCareReference`  | string      |                 |
| `NotesAccess`          | string      |                 |
| `CurrentStatus`        | string      |                 |
| `ServiceStatus`        | string      |                 |
| `ServiceStart`         | string      | Date format     |
| `ServiceEnd`           | string      | Date format     |
| `ServiceReview`        | string      | Date format     |
| `ServiceReview2`       | string      | Date format     |
| `EnquiryDate`          | string      | Date format     |
| `LastServiceReview`    | string      | Date format     |
| `ReasonServiceEnded`   | string      |                 |
| `NIDISNo`              | string      |                 |
| `NDISNumber`           | string      |                 |
| `NDISNote`             | string      |                 |
| `PensionNo`            | string      |                 |
| `CareRecipientId`      | string      |                 |
| `IsDex`                | integer     | 0/1             |
| `Status`               | string      |                 |
| `LocationId`           | integer     |                 |
| `Current`              | integer     | 0/1             |
| `CreatedBy`            | string      | Email format    |
| `CreatedTime`          | string      | Datetime format |
| `LastModifiedTime`     | string      | Datetime format |
| `PreferedWorker`       | array       |                 |
| `NonPreferedWorker`    | array       |                 |

Conditional fields are included when the corresponding `include*` flags are set to `TRUE` (see query parameters above).