Public API reference

The Visualcare public API provides programmatic access to your organisation’s data. All endpoints return JSON and use the base URL below. Base URL: https://publicapi.visualcare.com.au
Requesting API access To request API access for your Visualcare database, support@visualcare.com.au. The team provides API credentials and documentation for your specific integration needs.

Authentication

All API requests require three custom headers:

Header	Value
`User`	Your user UUID
`Key`	Your API key
`Secret`	Your API secret

Credentials are provided directly by Visualcare. Contact visualcare.com.au/contact to request credentials.

curl "https://publicapi.visualcare.com.au/{endpoint}"
    -H "User: user-uuid"
    -H "Key: key"
    -H "Secret: secret"

Query parameters

Query parameter names are case-sensitive and use lowerCamelCase, for example carerId, clientId, fromDate, includeNotes. A parameter sent with different casing, such as CarerId, is silently ignored and the unfiltered result is returned. Endpoint paths are not case-sensitive. Flag parameters such as includeDeleted are enabled by their presence, so includeDeleted=FALSE still includes deleted records. Omit the parameter to turn the behaviour off. Status values in responses are an empty string for active records and "D" for deleted records.

Error codes

Code	Meaning
400	Bad Request — Your request is invalid.
401	Unauthorized — Your API key is wrong.
403	Forbidden — The requested resource is hidden for administrators only.
404	Not Found — The specified resource could not be found.
405	Method Not Allowed — You tried to access a resource with an invalid method.
406	Not Acceptable — You requested a format that isn’t JSON.
410	Gone — The resource requested has been removed from our servers.
429	Too Many Requests — You’ve sent too many requests in a short period of time.
500	Internal Server Error — We had a problem with our server. Try again later.
503	Service Unavailable — We’re temporarily offline for maintenance. Try again later.

Successful requests return HTTP 200. GET endpoints return a JSON array. Errors are also returned with HTTP 200 and a body of {"status":"error","message":"..."}, so check the response body rather than the status code.

Endpoint summary table

Method	Path	Resource	Auth	Pagination
GET	`/areas`	Areas	Yes	No
GET	`/category-expenses`	Categories	Yes	No
GET	`/category-documents`	Categories	Yes	No
GET	`/category-incidents`	Categories	Yes	No
GET	`/category-payers`	Categories	Yes	No
GET	`/category-rosteritems`	Categories	Yes	No
GET	`/category-services`	Categories	Yes	No
GET	`/clients`	Clients	Yes	No
GET	`/agreements`	Agreements	Yes	Yes (limit/page)
GET	`/DEXCase`	DEX Cases	Yes	No
GET	`/contacts`	Contacts	Yes	No
GET	`/compliance-clients`	Client Compliance	Yes	No
GET	`/documents-clients`	Client Documents	Yes	No
GET	`/Expenses`	Client Expenses	Yes	No
GET	`/groups`	Client Groups	Yes	No
GET	`/notes-client`	Client Notes	Yes	Yes (limit/page)
GET	`/Divisions`	Divisions	Yes	No
GET	`/Forms`	Forms	Yes	Yes (limit/page)
GET	`/incidents`	Incidents	Yes	limit only, no page
GET	`/Leads`	Leads	Yes	No
GET	`/locations`	Locations	Yes	No
GET	`/payers`	Payers	Yes	No
GET	`/quotes`	Quotes	Yes	Yes (limit/page)
GET	`/Referral`	Referral Agencies	Yes	No
GET	`/rosters`	Roster Items	Yes	Yes (limit/page, max 20,000)
GET	`/roster-master`	Roster Masters	Yes	No
GET	`/services`	Services	Yes	No
GET	`/Settings`	Org Settings	Yes	No
GET	`/SIRS`	SIRS Incidents	Yes	limit only, no page
GET	`/skills`	Skills	Yes	No
GET	`/timesheets`	Timesheets	Yes	Yes (limit/page, max 40,000)
GET	`/Training-items`	Training Items	Yes	No
GET	`/Users`	Users	Yes	No
GET	`/workers`	Workers	Yes	No
POST	`/worker`	Create Worker	Yes	-
PUT	`/worker`	Update Worker	Yes	-
POST	`/worker-skill`	Add Worker Skill	Yes	-
PUT	`/worker-skill`	Update Worker Skill	Yes	-
GET	`/worker-roles`	Worker Roles	Yes	No
GET	`/availability`	Worker Availability	Yes	No
GET	`/documents-workers`	Worker Documents	Yes	No
POST	`/worker-doc`	Upload Worker Doc	Yes	-
PUT	`/worker-doc`	Update Worker Doc	Yes	-
GET	`/compliance`	Worker Compliance	Yes	No
POST	`/worker-compliance`	Add Worker Compliance	Yes	-
PUT	`/worker-compliance`	Update Worker Compliance	Yes	-
GET	`/Leave`	Worker Leave	Yes	No
GET	`/Training`	Worker Training	Yes	No
GET	`/nextshift`	Worker Next Shift	Yes	No
GET	`/prevshift`	Worker Previous Shift	Yes	No

Total: 50 endpoint operations across 46 unique URL paths

Endpoint pages

Clients

Client records, agreements, contacts, compliance, documents, expenses, groups, and notes

Workers

Worker records, skills, roles, availability, documents, compliance, leave, training, and shifts

Areas

Area lookup data

Divisions

Division lookup data

Locations

Location lookup data

Settings

Organisation-level settings

Services

Service definitions and rates

Rosters

Roster items and master list

Timesheets

Timesheet records

Leads and referrals

Lead records and referral agencies

Payers

Payer records

Users

User account records

Incidents

Incidents and SIRS records

Forms

Form submissions and data

Quotes

Quote records and line items

Frequently asked questions

Do API credentials expire?

No. API credentials have no expiry date. They stay valid until Visualcare deactivates them, for example when you ask for a replacement set or they’re revoked for security.The expiry date shown under Settings → Integrations belongs to the Services Australia (PRODA) device used for Support at Home claiming, not to your API credentials. See Server Error on the SAH tab for renewing that device.Credentials are issued for one database. If you run more than one Visualcare database, each one needs its own set.If requests start returning an error saying your API key is wrong, contact support@visualcare.com.au to have your credentials checked or reissued. Never send your key or secret in a support ticket; the team will tell you how to share them safely.

Does the API support webhooks?

No. The public API is request-based: your system calls the API to read or update data, and Visualcare doesn’t push changes to you.To act on new records, such as creating a user when a worker is added, call GET /workers on a schedule and compare the results with the records you’ve already processed.

Can I read or update leave balances?

GET /Leave returns worker leave records (dates, leave type and approval status). It doesn’t return leave balances, and there’s no endpoint for creating or updating leave.Leave balances are held in your payroll system. If you use Employment Hero, leave can be synced into Visualcare on request: see Employment Hero.

Can I connect Power BI to the API?

Yes. Power BI can call the API through Power Query, passing your credentials as headers. In Power BI Desktop, go to Get Data → Blank Query → Advanced Editor and use:

let
    Source = Json.Document(
        Web.Contents(
            "https://publicapi.visualcare.com.au",
            [
                RelativePath = "workers",
                Headers = [User = "your-user-uuid", Key = "your-key", Secret = "your-secret"]
            ]
        )
    ),
    Result = Table.FromRecords(Source)
in
    Result

Change workers to the endpoint you need. Errors come back with HTTP 200, so check the data for a status of error if a refresh returns no rows.Visualcare also builds custom Power BI reporting on top of the API as a paid service. Contact your Customer Success Manager or support@visualcare.com.au for a quote.

Overview

Clients

Workers

Categories

Organisation

Scheduling

People

Incidents

Records

Authentication

Query parameters

Error codes

Endpoint summary table

Endpoint pages

Clients

Workers

Categories

Areas

Divisions

Locations

Settings

Services

Rosters

Timesheets

Leads and referrals

Payers

Users

Incidents

Forms

Quotes

Frequently asked questions

​Authentication

​Query parameters

​Error codes

​Endpoint summary table

​Endpoint pages

Clients

Workers

Categories

Areas

Divisions

Locations

Settings

Services

Rosters

Timesheets

Leads and referrals

Payers

Users

Incidents

Forms

Quotes

​Frequently asked questions

Authentication

Query parameters

Error codes

Endpoint summary table

Endpoint pages

Frequently asked questions