Slot API

get /slots/available

Get available slots

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

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

Retrieve available slots for booking

Parameters

NameInTypeRequiredEnumDefaultDescription
X-ApiTokenheaderstringyesAPI token (e.g. your_api_token)
X-AccountCodeheaderstringyesAccount code (e.g. vclinic)

Responses

200 — Available slots

{
  "data": [
    {
      "id": "string",
      "provider_id": "string",
      "account_code": "string",
      "start": 0,
      "end": 0,
      "group_id": "string",
      "status": 0,
      "modified": 0,
      "created": 0,
      "group": {
        "id": "string",
        "date_start": "string",
        "date_end": "string",
        "time_start": "string",
        "time_end": "string",
        "repeat": true,
        "repeat_day": [
          "string"
        ],
        "repeat_week": 0,
        "account_code": "string",
        "provider_id": "string",
        "visit_type": "string",
        "consultation": {
          "id": "string",
          "description": "string",
          "duration": 0,
          "charge": true,
          "group": true,
          "slots": 0,
          "amount": 0,
          "visible_to_patient": true
        },
        "timezone": "string",
        "modified": 0,
        "created": 0
      },
      "provider": {
        "id": "string",
        "username": "string",
        "email": "string",
        "vseeid": "string",
        "full_name": "string",
        "specialties": [
          "string"
        ],
        "states_serviced": [
          "string"
        ],
        "clinics": [
          "string"
        ],
        "rooms": [
          {
            "id": "string",
            "code": "string",
            "name": "string",
            "slug": "string",
            "domain": "string",
            "account_code": "string"
          }
        ]
      },
      "account": {
        "id": "string",
        "name": "string",
        "domain": "string",
        "code": "string"
      }
    }
  ]
}

Machine-readable: OpenAPI JSON (operationId: getAvailableSlots)