Skip to main content
GET
List bookings

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

bookingScheduleId
integer
selectedLocationId
integer

For EVENT-profile schedules — filter to bookings made against one location (an id from GET /booking-schedules/{bookingScheduleId}/locations). Ignored for INTERVIEW-profile schedules, which have no locations.

The most broadly applicable filter — the id returned by POST /booking-schedules/{bookingScheduleId}/links when you created the candidate's scheduling link.

entityType
string

Must be combined with entityId. See the Booking.entityType field.

entityId
string

Must be combined with entityType — ids are not necessarily unique across candidate types.

status
enum<string>

Lifecycle status of a booking. ACTIVE is the only status a booking can be rescheduled or cancelled from. Rescheduling cancels the current booking (its status becomes CANCELLED) and creates a new ACTIVE booking — see RescheduleBookingResponse.

Available options:
ACTIVE,
ATTENDED,
NOT_ATTENDED,
CANCELLED
Example:

"ACTIVE"

from
string<date-time>

Only bookings with scheduledStartAt on or after this date-time.

to
string<date-time>

Only bookings with scheduledStartAt before this date-time.

page
integer
default:1
perPage
integer
default:20

Response

Matching bookings.

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