v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB

Schedules

List participant pool schedules

Get a list of all participant pool schedules with optional filtering

get/participant-pool-schedules

Query parameters

ownerIdstring

Filter by owner ID

createdAfterstring date-time

Filter schedules created after this date

createdBeforestring date-time

Filter schedules created before this date

hasRecurringSlotsboolean

Filter by presence of recurring time slots

hasFixedSlotsboolean

Filter by presence of fixed time slots

limitinteger

Maximum number of schedules to return

skipinteger

Number of schedules to skip

Response

A directory with a data property that contains an array of up to limit participant pool schedules, starting after skip. Each entry in the array is a separate schedule object. If no more schedules are available, the resulting array will be empty. This request should never return an error.

hasMoreboolean

Indicates if there are more schedules to fetch

totalinteger

Total number of schedules matching the filter criteria

Example response

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