Visit API

get /visits/{id}

Get visit detail

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

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

Get detailed information for a specific visit or appointment

Returns full visit details including members, intake data, meeting info, and (optionally) recordings.

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)
id	path	string	yes			Visit ID (e.g. 7727)

Responses

200 — Visit details retrieved successfully

Visit details — Complete visit information

{
  "data": {
    "id": "18407167",
    "member_id": 17778181,
    "provider_id": 12456470,
    "account_code": "vclinic",
    "code": "615f2e2eabc46ad94e9b6457b11",
    "start": 1631628616,
    "end": 1631628916,
    "actual_start": 1631628211,
    "type": 2,
    "status": 30,
    "room_code": "vclinicroom",
    "created": 1633627694,
    "modified": 1633630312,
    "provider": {
      "id": "12456470",
      "email": "doctor@vseelab.com",
      "full_name": "Dr. Anton Provider"
    },
    "member": {
      "id": "17778181",
      "email": "patient@vseelab.com",
      "full_name": "Anton Test",
      "phone": "5551231122"
    },
    "intake": {
      "provider_id": "12456470",
      "member_id": "17778181",
      "room_code": "vclinicroom",
      "reason_for_visit": "Follow-up consultation"
    }
  }
}

401 — Unauthorized

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

Machine-readable: OpenAPI JSON (operationId: getVisit)