# Slot API
Landing: https://developers.vsee.io/api/slot-api  ·  Spec JSON: https://developers.vsee.io/specs/slot_api_openapi.json
Base URL: https://api.vseepreview.com/api_v3



The Slot API provides time slot availability for scheduling appointments. Slots are defined by providers and represent available time windows for patient bookings.

## GET /slots
URL: https://developers.vsee.io/api/slot-api/get/slots
operationId: listSlots
Auth: User Token — Requires a user access token from login or SSO.

List slots

Retrieve a list of slots with optional filtering by various criteria

Parameters:
- X-ApiToken (header, string, required) — API token
- X-AccountCode (header, string, required) — Account code
- start (query, integer, required) — UNIX timestamp for start of range
- end (query, integer, required) — UNIX timestamp for end of range
- status (query, integer, optional) — Filter by status. Use 10 for open slots
- type (query, string, optional) — Type of slot [enum: one, group]
- provider_id (query, string, optional) — Filter by provider ID
- room_code (query, string, optional) — Filter by room code
- account_code (query, string, optional) — Filter by account code
- specialty_id (query, string, optional) — Filter by specialty ID
- states_serviced (query, string, optional) — Filter by states serviced

Responses:
- 200 — List of slots
```json
{
  "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)"
      }
    }
  ]
}
```

## GET /slots/available
URL: https://developers.vsee.io/api/slot-api/get/slots/available
operationId: getAvailableSlots
Auth: User Token — Requires a user access token from login or SSO.

Get available slots

Retrieve available slots for booking

Parameters:
- X-ApiToken (header, string, required) — API token
- X-AccountCode (header, string, required) — Account code

Responses:
- 200 — Available slots
```json
{
  "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"
      }
    }
  ]
}
```

## DELETE /slots/{id}
URL: https://developers.vsee.io/api/slot-api/delete/slots/%7Bid%7D
operationId: deleteSlot
Auth: User Token — Requires a user access token from login or SSO.

Delete slot

Delete a single slot by ID

Parameters:
- X-ApiToken (header, string, required) — API token
- X-AccountCode (header, string, required) — Account code
- id (path, string, required) — Slot ID

Responses:
- 200 — Slot deleted successfully
```json
{
  "data": {
    "slot_deleted": 1,
    "group_deleted": 1
  }
}
```

## DELETE /slots/groups/{groupId}
URL: https://developers.vsee.io/api/slot-api/delete/slots/groups/%7BgroupId%7D
operationId: deleteSlotGroup
Auth: User Token — Requires a user access token from login or SSO.

Delete slot group

Delete a slot group and all associated slots

Parameters:
- X-ApiToken (header, string, required) — API token
- X-AccountCode (header, string, required) — Account code
- groupId (path, string, required) — Slot group ID

Responses:
- 200 — Slot group deleted successfully
```json
{
  "data": {
    "slot_deleted": 2,
    "group_deleted": 1
  }
}
```