Skip to main content
Any API POST/PUT request won’t trigger a workflow.

​
GET /documents-worker

Retrieves all worker documents (metadata only, no file content or download). Parameters: Response:
Response fields:
Limitations:
  • No file content or binary is returned, only metadata.
  • No documented endpoint exists to download file content by DocId.
  • The response doesn’t include CategoryId, upload date/time, or file size.

​
POST /worker-doc

Uploads a document to a worker’s profile. Required fields: CarerId Conditionally required: CategoryId (if org settings mandate category on upload) Content-Type: This endpoint appears to use multipart/form-data based on the curl example using -F. The documentation shows both a curl -F flag example and a separate JSON body example, which is ambiguous. Curl example (multipart/form-data):
The multipart field name for the file is file (lowercase), based on the curl -F "file=@..." example. JSON body fields: Example JSON body:
Critical documentation gaps for POST /worker-doc:
  1. No success response example. The docs don’t show what a successful upload returns (status code, body structure, whether it returns the new DocId, and so on).
  2. Ambiguous content type. The curl uses -F (multipart/form-data) but a separate JSON body is also shown. It’s unclear whether both are sent together as multipart fields, or if these are alternative approaches.
  3. The Filename field purpose is unclear. It shows a local Windows path - it may be a display name override or a legacy field. The actual file binary appears to be sent via the file multipart field.
  4. No error response examples.
  5. Whether a 200 with null/empty body is expected behaviour is not documented.
  6. The curl example URL uses documents-workers (the GET endpoint path), not worker-doc (the stated POST endpoint path). This is likely a documentation error - the actual POST URL per the <Request> component is /worker-doc.

​
PUT /worker-doc

Updates metadata on an existing worker document. Required fields: LinkId
The required field is LinkId, not DocId. The relationship between LinkId and DocId is not explicitly documented.
Content-Type: application/json Request body:
No success or error response examples are provided.