Public API reference

​

Authentication

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

​

Error codes

​

Known documentation quirks

​

Typos in API responses

​

URL inconsistencies

• Some curl examples in the docs use publicapi.visualcare.com (without .au), but the actual base URL is publicapi.visualcare.com.au.
• The POST /worker-doc curl example targets documents-workers (the GET path) instead of worker-doc (the stated POST path). The <Request> component confirms the POST URL is /worker-doc.

​

Undocumented behaviours

1. POST/PUT success responses: No POST or PUT endpoint documents what a successful response looks like (status code, body, returned IDs).
2. POST /worker-doc content type: Ambiguous — shows both multipart/form-data (-F "file=@...") and JSON body. Likely requires multipart/form-data with both the file and metadata fields.
3. No file download endpoint: Documents can be listed but not retrieved or downloaded via the API.
4. No client document upload: Only worker documents have POST/PUT endpoints. Client documents are read-only.
5. LinkId vs DocId: Worker document PUT uses LinkId (not DocId). The mapping between these IDs is not documented.
6. Boolean string encoding in POST/PUT: Boolean values in POST/PUT bodies use string "TRUE" / "FALSE", not native JSON booleans. Integer 0/1 booleans appear only in GET responses.
7. Pagination default: Most paginated endpoints default to 200 items. page is an offset (number of records to skip), not a page number.
8. POST /worker body wrapping: The POST worker body is wrapped in a JSON array [{...}], while POST worker-skill and worker-compliance use a plain object {...}.

​

Endpoints not in main navigation (but documented)

• GET /nextshift — Worker’s next shift
• GET /prevshift — Worker’s previous shift

​

Endpoint summary table

​

Endpoint pages