Slot API

get /slots

List slots

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

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

Retrieve a list of slots with optional filtering by various criteria

Parameters

NameInTypeRequiredEnumDefaultDescription
X-ApiTokenheaderstringyesAPI token (e.g. your_api_token)
X-AccountCodeheaderstringyesAccount code (e.g. vclinic)
startqueryintegeryesUNIX timestamp for start of range
endqueryintegeryesUNIX timestamp for end of range
statusqueryintegernoFilter by status. Use 10 for open slots
typequerystringnoone, groupType of slot
provider_idquerystringnoFilter by provider ID
room_codequerystringnoFilter by room code
account_codequerystringnoFilter by account code
specialty_idquerystringnoFilter by specialty ID
states_servicedquerystringnoFilter by states serviced

Responses

200 — List of slots

success

{
  "data": [
    {
      "id": "63850640-129c-4e8a-af18-0b9f0a7d64b7",
      "provider_id": "9046",
      "account_code": "bac-team",
      "start": 1669836600,
      "end": 1669838400,
      "group_id": "63850640-2cf0-4822-a0bc-0b9f0a7d64b7",
      "status": 10,
      "modified": 1669662272,
      "created": 1669662272,
      "group": {
        "id": "63850640-2cf0-4822-a0bc-0b9f0a7d64b7",
        "date_start": "1669827600",
        "date_end": "1669913999",
        "time_start": "1669836600",
        "time_end": "1669838400",
        "repeat": false,
        "repeat_day": [],
        "repeat_week": 1,
        "account_code": "bac-team",
        "provider_id": "9046",
        "visit_type": "group",
        "timezone": "Asia/Ho_Chi_Minh"
      },
      "provider": {
        "id": "9046",
        "username": "bac+provider3@vseelab.com",
        "email": "bac+provider3@vseelab.com",
        "vseeid": "bac+provider3@vseelab.com",
        "full_name": "Bac Provider3 (edited)"
      }
    }
  ]
}

Machine-readable: OpenAPI JSON (operationId: listSlots)