File Upload API

get /files

List files

Base URL https://api.vseepreview.com/api_v3

Authentication: User Token — Requires a user access token from login or SSO.

Retrieve list of files with optional filtering

Parameters

Name	In	Type	Required	Enum	Default	Description
X-ApiToken	header	string	yes			API token (e.g. your_api_token)
X-AccountCode	header	string	yes			Account code (e.g. vclinic)
target_id	query	string	no			The ID of the target (user_id or visit_id) (e.g. 2317820300)
target_type	query	string	no	user, visit		Target type (user or visit) (e.g. user)
category_type	query	string	no			File category type (user_document, intake_attachment, user_consent, user_avatar) (e.g. user_document)
include_shared	query	boolean	no			Include shared files (e.g. true)

Responses

200 — Successful response

Files List

{
  "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"
        }
      },
      "name": "2017-01-21 04:00:00 - filename.pdf",
      "size": 274988
    }
  ]
}

Machine-readable: OpenAPI JSON