Skip to main content
GET
List booking schedules

Authorizations

Authorization
string
header
required

Company-scoped API key. Production keys are prefixed sk_live_, sandbox keys sk_test_, each followed by 22 base62 characters (pattern ^sk_(live|test)_[0-9A-Za-z]{22}$). Generate keys in the TapTalent dashboard under Account Settings → Developers → API Key Management; a key is shown once at generation and old keys are invalidated immediately on regeneration.

Query Parameters

scheduleProfile
enum<string>

Filter to one schedule profile. Distinguishes an interview-style schedule (candidate books a single slot, optionally at a single onsite companySiteId) from a generic event schedule (candidate picks among multiple configured locations — see GET /booking-schedules/{bookingScheduleId}/locations — and answers custom booking questions — see GET /booking-schedules/{bookingScheduleId}/questions). Both profiles support booking-link creation, direct booking creation, attendance recording (a check-in code/QR is issued for every booking regardless of profile), and rescheduling/cancellation through this API — see POST /booking-schedules/{bookingScheduleId}/bookings and the note above this schema's usages for the small differences between them (e.g. selectedLocationId/bookingAnswers only apply to EVENT).

Available options:
INTERVIEW,
EVENT
Example:

"INTERVIEW"

bookingMode
enum<string>

How a booking schedule can be attended. ONLINE schedules generate a virtual meeting link; ONSITE schedules are tied to a single company site (companySiteId); BOTH lets the candidate pick a format when booking (see Booking.selectedFormat).

Available options:
ONLINE,
ONSITE,
BOTH
Example:

"ONSITE"

Response

All matching booking schedules for the company.

status
string
required
Allowed value: "success"
data
object[]
required