Visit API

get /availability

Get provider's available slots

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

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

Retrieve available appointment slots for providers based on search criteria

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			Room code (optional if using intake_id) (e.g. xxxx)
start	query	integer	yes			UNIX timestamp - search for available slots from this start time (e.g. 1668129300)
end	query	integer	yes			UNIX timestamp - search for available slots up to this end time (e.g. 1670000000)
duration	query	integer	no			Duration in seconds - search for available slots during this duration (optional)
provider_id	query	string	no			Provider ID - pick only this provider's slots (optional)
intake_id	query	string	no			Intake ID - should be passed when patient is choosing a slot (optional)
consultation_id	query	string	no			Consultation ID - helps determine slot duration (optional)
location	query	string	no			Location code like AL, CA (optional - for filtering by state)

Responses

200 — Available slots retrieved successfully

Available slots — List of available appointment slots

{
  "data": {
    "slots": [
      {
        "slot_id": "10996909",
        "slot_start": 1669239900,
        "slot_end": 1669240800,
        "slot_booked": 0,
        "slot_available": 1,
        "group_id": "637e920e-bd34-4d3f-82c0-804b0adc0a9f"
      },
      {
        "slot_id": "10996909",
        "slot_start": 1669240800,
        "slot_end": 1669241700,
        "slot_booked": 0,
        "slot_available": 1,
        "group_id": "637e920e-bd34-4d3f-82c0-804b0adc0a9f"
      }
    ],
    "slot_data": {
      "10996909": {
        "id": "10996909",
        "provider_id": "12456470",
        "account_code": "carebyte",
        "start": "1669239900",
        "end": "1669243500",
        "group_id": "637e920e-bd34-4d3f-82c0-804b0adc0a9f",
        "status": "10",
        "consultation": {
          "duration": 15,
          "slots": 1
        }
      }
    }
  }
}

400 — Bad request - missing required parameters

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

401 — Unauthorized

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

Machine-readable: OpenAPI JSON (operationId: getAvailability)