Sign in

v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB
Schedules

List fixed time slots

Get a list of all fixed time slots for a specific schedule

get/participant-pool-schedules/{participantPoolScheduleId}/fixed-time-slots

Query parameters

startDatestring date

Filter by start date (inclusive)

endDatestring date

Filter by end date (inclusive)

kind'AVAILABLE' | 'UNAVAILABLE'

Type of time slot for participant pool schedule

Filter by time slot kind

isActiveboolean

Filter by active status

Response

List of fixed time slots retrieved successfully

idstring

Unique identifier for this fixed time slot

datestring date required

Specific date for this time slot

startTimestring required

Start time in HH:MM format (24-hour)

endTimestring required

End time in HH:MM format (24-hour)

kind'AVAILABLE' | 'UNAVAILABLE' required

Type of time slot for participant pool schedule

timezonestring

Timezone for this time slot

reasonstring

Optional reason for this fixed time slot (e.g., "Holiday", "Special Event")

overridesRecurringboolean

Whether this fixed slot overrides any conflicting recurring slots

isActiveboolean

Whether this fixed time slot is currently active

createdAtstring date-time

Timestamp when the fixed time slot was created

updatedAtstring date-time

Timestamp when the fixed time slot was last updated

Example response

[
  {
    "date": "2024-12-25",
    "startTime": "09:00",
    "endTime": "17:00",
    "timezone": "America/New_York"
  }
]