Visit API

get /visits

List visits

Base URL https://api.vseepreview.com/api_v3 · operationId listVisits

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

Get the visits list of the patient. Upcoming appointments have start > current timestamp.

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)
room_code	query	string	no			Filter visits by room code
start_time	query	integer	no			Filter visits starting after this UNIX timestamp
end_time	query	integer	no			Filter visits ending before this UNIX timestamp
status	query	string	no			Filter by visit status. Values: 10 (Pending), 20 (Confirmed), 25 (In-progress), 30 (Completed), 40 (Cancelled)
fields	query	string	no			Comma-separated field names to return. Include `recordings` to receive recording objects for each visit.
with_recordings_only	query	integer	no	0, 1		Set to `1` to filter out visits without recordings. When `fields` includes `recordings`, this flag includes the recordings object in each visit.

Responses

200 — Visits list retrieved successfully

Visits list — List of patient visits

{
  "data": [
    {
      "id": "7727",
      "member_id": "575",
      "provider_id": "1096",
      "account_code": "vclinic",
      "code": "57a07c26947c4544aeef4e5cac1f0144",
      "start": "1470669300",
      "end": "1470670200",
      "type": "2",
      "status": "20",
      "created": 1470135334,
      "modified": 1470135334,
      "provider": {
        "id": "1096",
        "first_name": "Anton",
        "last_name": "Provider III"
      },
      "member": {
        "id": "575",
        "first_name": "Keven2",
        "last_name": "Teodoro2"
      }
    }
  ]
}

401 — Unauthorized

{
  "error": "Unauthorized",
  "message": "Invalid or missing API token"
}

Machine-readable: OpenAPI JSON (operationId: listVisits)