...
Parameter | Type | Description |
---|---|---|
|
| The id of the target which is related to the files |
|
| The file of the target which is related to the files. For now the possible values are 'user' and 'visit' |
|
| The category type of this file. For now the possible reasons are 'user_document', 'intake_attachment', 'user_consent', 'user_avatar'. |
include_shared |
| Include this param will get all the files that tagged user_document and notes files that shared to the user. |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
curl --location --request GET \ > 'https://api-vclinic.vsee.me/api_v3/files?target_id=2317820300&target_type=user' \ > --header 'X-AccountCode: vclinic' --header 'X-ApiToken: vclinic_api_key' { "data": [ { "created": 1657668358, "creator": { "full_name": "Patient's Name", "type": 200, "username": "62ce09a2940adc6474" }, "ext": "pdf", "fullpath": "https://api-vclinic.vsee.me/files/view/62ce0306-bd68-8fj3-7771-6dfc0ks8219474?auth_code=bb7e2d413f9jd93unf92u4e35584d10&time=1669924552", "id": "62ce0306-bd68-8fj3-7771-6dfc0ks8219474", "is_deletable": true, "meta": { "account": { "code": "vclinic" }, "category": "user_document", "target": { "id": "2317820300", "type": "user" }, "visible": true }, "name": "2017-01-21 04:00:00 - filename.pdf", "size": 274988 } ] } |
...