# GET /availability URL: https://developers.vsee.io/api/visit-api/get/availability operationId: getAvailability Auth: User Token — Requires a user access token from login or SSO. Get provider's available slots Retrieve available appointment slots for providers based on search criteria Parameters: - X-ApiToken (header, string, required) — API token - X-AccountCode (header, string, required) — Account code - room_code (query, string, optional) — Room code (optional if using intake_id) - start (query, integer, required) — UNIX timestamp - search for available slots from this start time - end (query, integer, required) — UNIX timestamp - search for available slots up to this end time - duration (query, integer, optional) — Duration in seconds - search for available slots during this duration (optional) - provider_id (query, string, optional) — Provider ID - pick only this provider's slots (optional) - intake_id (query, string, optional) — Intake ID - should be passed when patient is choosing a slot (optional) - consultation_id (query, string, optional) — Consultation ID - helps determine slot duration (optional) - location (query, string, optional) — Location code like AL, CA (optional - for filtering by state) Responses: - 200 — Available slots retrieved successfully ```json { "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 ```json { "error": "Unauthorized", "message": "Invalid or missing API token" } ``` - 401 — Unauthorized ```json { "error": "Unauthorized", "message": "Invalid or missing API token" } ```