Clinia
API ReferenceREST API

Browse VFS

GET
/v1/patients/{patientId}/vfs

Lists the contents of a VFS path. Returns directory children with name, type, and preview, or file content when the path resolves to a file. Defaults to the root when path is omitted. The patientId here is the registry key; VFS paths internally use the patient ID extracted from the ingested record.

Path Parameters

patientId*string

Registry key of the patient, as assigned by the caller when the first ingest was submitted.

Match^[A-Za-z0-9._-]{1,128}$

Query Parameters

path?string

Absolute VFS path to browse. Defaults to the root when omitted.

Default""

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/patients/patient-123/vfs"
{
  "path": "string",
  "type": "directory",
  "children": [
    {
      "name": "string",
      "type": "directory",
      "preview": "string"
    }
  ],
  "content": "string"
}
{
  "code": 1,
  "type": "ALREADY_EXISTS",
  "message": "string"
}