GET /api/v1/appointments/appointment_slots

Returns all the appointment slots with availablity for a given date.

Supported Formats

json

Errors

Code Description
404 Not found.
422 Unprocessable Entity.
500 Internal Server Error.

Examples

curl --location --request GET 'https://app.octopi.co/api/v1/appointments/appointment_slots'     --header 'Authorization: Token token==ADD TOKEN HERE'     --header 'Content-Type: application/json'     --data-raw '{
  "appointment_date": "2023-08-21"
}'

{
  "appointment_slots": [
    {
      "appointment_slot_id": 1098,
      "appointment_date": "2023-08-21",
      "slot_timings": "04:00 PM - 05:00 PM",
      "terminal": "Main Terminal",
      "overall_capacity": 10,
      "available_slots": 3
    },
    {
      "appointment_slot_id": 1120,
      "appointment_date": "2023-08-21",
      "slot_timings": "05:00 PM - 06:00 PM",
      "terminal": "Main Terminal",
      "overall_capacity": 10,
      "available_slots": 5
    }
  ]
}

Params

Param name Description
appointment_date
required

Date for which you want the appointment slot details for. Must be formatted as YYYY-MM-DD.

Validations:

  • Must be a String
terminal
optional

The name of the terminal for which you want the appointment slots for. Terminal is mandatory if there are multiple active terminals present for your organization.

Validations:

  • Must be a String