PApactima
Schedules

List recurring time slots

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

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

Request

  • Base URL
    https://rest.api.pactima.com/v1
  • URL
    https://rest.api.pactima.com/v1/participant-pool-schedules/{participantPoolScheduleId}/recurring-time-slots
  • Auth
    HTTP bearer

Query parameters

dayOfWeekinteger

Filter by day of week (0=Sunday, 6=Saturday)

kind'AVAILABLE' | 'UNAVAILABLE'

Type of time slot for participant pool schedule

Filter by time slot kind

isActiveboolean

Filter by active status

Response

List of recurring time slots retrieved successfully

idstring

Unique identifier for this recurring time slot

dayOfWeekinteger required

Day of week (0=Sunday, 1=Monday, ..., 6=Saturday)

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

effectiveFromstring date

Date when this recurring pattern becomes effective

effectiveUntilstring date

Date when this recurring pattern expires (optional)

isActiveboolean

Whether this recurring time slot is currently active

createdAtstring date-time

Timestamp when the recurring time slot was created

updatedAtstring date-time

Timestamp when the recurring time slot was last updated

Example response

[
  {
    "startTime": "09:00",
    "endTime": "17:00",
    "timezone": "America/New_York"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.