Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Returns GET {baseUrl}/queues/{queueId}/timeslots

This endpoint returns a list of available time slots, including information details about their availability within a specified period.

Query String Parameters

Use the following parameters in the query string to specify the time period and time zone details:

Name

Type

Description

minDate

date (ISO string)

Minimum date (start of the period) for which to fetch time slots.

maxDate

date (ISO string)

Maximum date (end of the period) for which to fetch time slots.

inLocalTime

boolean (optional)

Adds startLocal and endLocal to the response, adjusting the dates to the time zone of the queue. This should be used only if local time zone adjustment cannot be performed client-side.

Request

Code Block
curl --location --request GET '{baseUrl}/queues/{queueId}/timeslots?minDate=2020-12-01T10:00:00.000Z&maxDate=2020-12-01T20:00:00.000Z' \
--header 'Content-Type: application/json'

Response

Code Block
[
    {
        "start": "2020-12-01T10:00:00.000Z",
        "end": "2020-12-01T10:30:00.000Z",
        "available": true,
        "availableCapacity": 50
    },
    {
        "start": "2020-12-01T10:30:00.000Z",
        "end": "2020-12-01T11:00:00.000Z",
        "available": true,
        "availableCapacity": 50
    }
]

Request

Code Block
curl --location --request GET '{baseUrl}/queues/{queueId}/timeslots?minDate=2020-12-01T10:00:00.000Z&maxDate=2020-12-01T20:00:00.000Z&inLocalTime=true' \
--header 'Content-Type: application/json'

Response

Code Block
[
    {
        "start": "2020-12-01T10:00:00.000Z",
        "end": "2020-12-01T10:30:00.000Z",
        "available": true,
        "startLocal": "2020-12-01T11:00:00+01:00",
        "endLocal": "2020-12-01T11:30:00+01:00",
        "availableCapacity": 50
    },
    {
        "start": "2020-12-01T10:30:00.000Z",
        "end": "2020-12-01T11:00:00.000Z",
        "startLocal": "2020-12-01T11:30:00+01:00",
        "endLocal": "2020-12-01T12:00:00+01:00"
        "available": true,
        "availableCapacity": 50
    }
]