> ## Documentation Index > Fetch the complete documentation index at: https://docs.taptalent.io/llms.txt > Use this file to discover all available pages before exploring further. # Get a booking schedule > Retrieves a single booking schedule. You can only access schedules that belong to your company. ## OpenAPI ````yaml /api-reference/openapi.yaml get /booking-schedules/{bookingScheduleId} openapi: 3.1.0 info: title: TapTalent Partner API version: 1.0.0 summary: Partner API for jobs, candidates, pipelines, custom fields, and webhooks. description: > The TapTalent Partner API lets partner systems manage jobs, candidates, job-candidate relationships, hiring pipelines, and custom fields, and receive real-time event notifications via webhooks. All communication is JSON over HTTPS. ## Authentication Every request requires an API key sent as an HTTP bearer token: ``` Authorization: Bearer sk_live_AbCdEfGhIjKlMnOpQrStUv ``` Keys are prefixed `sk_live_` (production) or `sk_test_` (sandbox) followed by 22 base62 characters, are scoped to a company, and are generated from the TapTalent dashboard (Account Settings → Developers → API Key Management). Key management is dashboard-only and not available via this API. ## Response envelopes The API uses three envelope styles, by resource family: | Family | Success envelope | |---|---| | Jobs | Bare object (e.g. `{ "jobs": [...], "totalJobs": 45 }` or the job object itself) | | Candidates, Job Candidates, Pipelines, Custom Fields, Candidate Self-Scheduling | `{ "status": "success", "data": ... }` | | Candidates, Job Candidates, Pipelines, Custom Fields | `{ "status": "success", "data": ... }` | | Bulk resume upload and batch retrieval | `{ "success": true, "data": ... }` | Each operation in this specification models its family's actual envelope; no unified envelope is imposed. ## Pagination Pagination conventions vary by endpoint and are modeled as documented: | Endpoint | Page parameter | First page | Default page size | Page size rule | |---|---|---|---|---| | `GET /jobs` | `pageNumber` | 1 | 10 | one of 10, 20, 40, 80, 100 | | `GET /candidates/list` | `pageNumber` | **0** | 10 | one of 10, 20, 40, 80, 100 | | `GET /candidates/batch/{batchId}` | `pageNumber` | 1 | 10 | one of 10, 20, 40, 80, 100 | | `GET /job-candidates/job/{jobId}/candidates` | `page` | 1 | 20 | one of 10, 20, 40, 80, 100 | | `GET /job-candidates/stage/{stageId}/candidates` | `page` | 1 | 20 | any value from 1 to 100 | | `GET /bookings` | `page` | 1 | 20 | any value from 1 to 100 | ## Errors Most errors use the canonical envelope: ```json { "error": { "code": "ERROR_CODE", "type": "error_type", "message": "Human-readable error message", "details": { "field": "Specific validation error message" } } } ``` Authentication failures use flat shapes instead (`{"message": ...}`, `{"code": ..., "message": ...}` or `{"message": ..., "isApiKeyExists": false}`); see the shared 401 response. Rate limits are applied at the company level; numeric limits and the 429 response body are not yet published. ## Webhooks Event notifications are delivered as HTTP POST requests to a single company-level HTTPS endpoint configured in the dashboard. Deliveries carry the headers `X-Webhook-Event`, `X-Webhook-Timestamp`, and `X-Webhook-Key` (verify by plain equality against the key generated in the dashboard; HMAC signatures are not yet available). Endpoints must respond with a 2xx status within 5 seconds; failed deliveries are retried at 200 ms, 400 ms, and 800 ms before being marked failed. See the `webhooks` section of this document for every event payload. ## Conventions used in this specification - `x-inferred: true` marks schemas or responses whose shape is inferred from related endpoints because the source documentation does not include an example; verify against the sandbox before relying on exact field names. - `x-known-quirk` marks fields whose wire format deviates from the API's prevailing conventions (for example an epoch timestamp where other endpoints return ISO 8601 strings). - Where the published documentation shows placeholder string identifiers (for example `"pipelineId_1"` or `"companyId_1"`), this specification models the underlying integer identifier types used by the API and notes the resolution on the affected field. contact: name: TapTalent Support email: support@taptalent.ai url: https://docs.taptalent.io license: name: Proprietary url: https://taptalent.ai servers: - url: https://partner-api.taptalent.io/v1/partner description: Production (use `sk_live_` keys) - url: https://sandbox.partner-api.taptalent.io/v1/partner description: Sandbox / staging (use `sk_test_` keys) security: - bearerAuth: [] tags: - name: Jobs description: Create, read, update, and list jobs. - name: Candidates description: >- Create and retrieve candidates, upload resumes in bulk, and fetch candidates by batch or id list. - name: Job Candidates description: >- Manage the relationship between candidates and jobs, including stage placement and per-job resume ingestion. - name: Pipelines description: Manage hiring pipelines and their stages. - name: Custom Fields description: Define custom field templates for candidates and jobs. - name: Custom Field Values description: Read and write custom field values attached to candidates and jobs. - name: Candidate Self-Scheduling description: | Read booking schedules and their availability, generate candidate scheduling links, and read, reschedule, cancel, and record attendance for the bookings candidates make on them. - name: Webhooks description: >- Event notifications delivered to your configured webhook endpoint. See the top-level `webhooks` section for payloads. paths: /booking-schedules/{bookingScheduleId}: get: tags: - Candidate Self-Scheduling summary: Get a booking schedule description: >- Retrieves a single booking schedule. You can only access schedules that belong to your company. operationId: getBookingSchedule parameters: - name: bookingScheduleId in: path required: true schema: type: integer example: 501 responses: '200': description: The booking schedule. content: application/json: schema: $ref: '#/components/schemas/GetBookingScheduleResponse' examples: schedule: value: status: success data: id: 501 name: Bridgetown Site — Background Check Appointment description: Bring a valid government ID. durationMinutes: 30 timezone: Asia/Manila bookingMode: ONSITE scheduleProfile: INTERVIEW companySiteId: 12 visibleDaysAhead: 7 expiresAt: null allowCandidateReschedule: true rescheduleCutoffHours: 4 isAllDayEvent: false '401': $ref: '#/components/responses/Unauthorized' '404': description: No schedule with this id in your company. content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: notFound: value: error: code: NOT_FOUND type: not_found message: Booking schedule not found '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' components: schemas: GetBookingScheduleResponse: type: object required: - status - data properties: status: type: string const: success data: $ref: '#/components/schemas/BookingSchedule' ApiError: type: object description: Canonical error envelope used by most non-authentication errors. required: - error properties: error: $ref: '#/components/schemas/ApiErrorBody' BookingSchedule: type: object description: | A reusable, bookable schedule — an interview slot template, or a vendor/site appointment type such as a background check. Recruiters create schedules and configure their availability from the TapTalent dashboard; schedule creation and availability configuration are not available via this API. required: - id - name - durationMinutes - timezone - bookingMode - scheduleProfile properties: id: type: integer description: Unique identifier of the booking schedule. examples: - 501 name: type: string description: Display name of the schedule. examples: - Bridgetown Site — Background Check Appointment description: type: - string - 'null' description: Free-text description shown to the candidate on the booking page. durationMinutes: type: integer description: Length of each bookable slot, in minutes. examples: - 30 timezone: type: string description: >- IANA timezone the schedule's slots and displayed times are computed in. examples: - Asia/Manila bookingMode: $ref: '#/components/schemas/BookingMode' scheduleProfile: $ref: '#/components/schemas/ScheduleProfile' companySiteId: type: - integer - 'null' description: >- The company site this schedule is bound to, when `bookingMode` is `ONSITE` (or `BOTH` and the candidate picks onsite). `null` for online-only schedules. examples: - 12 visibleDaysAhead: type: integer description: How many days of future availability are shown to the candidate. examples: - 7 expiresAt: type: - string - 'null' format: date-time description: If set, the schedule stops accepting new bookings after this time. allowCandidateReschedule: type: boolean description: >- Whether a booking made against this schedule can be rescheduled, by the candidate or via `POST /bookings/{bookingId}/reschedule`. rescheduleCutoffHours: type: - integer - 'null' description: >- Minimum hours of notice required before the current appointment time to reschedule. `null` means no cutoff is enforced. examples: - 4 isAllDayEvent: type: boolean description: >- Whether slots for this schedule span the full day rather than `durationMinutes`-sized blocks. AuthMessageError: type: object description: >- Flat authentication error shape (does not use the canonical `error` envelope). required: - message properties: message: type: string examples: - Invalid API key AuthCodeMessageError: type: object description: >- Flat authentication error shape returned when the account subscription is inactive. required: - code - message properties: code: type: string examples: - ACCOUNT_INACTIVE message: type: string examples: - >- Your subscription is inactive. Please renew your plan to continue using this feature. AuthApiKeyError: type: object description: >- Flat authentication error shape returned when the API key does not exist. required: - message - isApiKeyExists properties: message: type: string examples: - API key not found isApiKeyExists: type: boolean ApiErrorBody: type: object description: Canonical error object carried under the `error` key. required: - code - type - message properties: code: type: string description: Machine-readable error code, e.g. `INVALID_REQUEST`. examples: - INVALID_REQUEST type: type: string description: Error category. enum: - validation_error - internal_error - not_found - authorization_error - resource_error - payment_error - subscription_error message: type: string description: Human-readable error message. details: type: object description: Optional per-field validation messages or structured error context. additionalProperties: true BookingMode: type: string description: | 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`). enum: - ONLINE - ONSITE - BOTH examples: - ONSITE ScheduleProfile: type: string description: | 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`). enum: - INTERVIEW - EVENT examples: - INTERVIEW responses: Unauthorized: description: | Authentication failed. Note that authentication errors use flat body shapes rather than the canonical `error` envelope. content: application/json: schema: anyOf: - $ref: '#/components/schemas/AuthMessageError' - $ref: '#/components/schemas/AuthCodeMessageError' - $ref: '#/components/schemas/AuthApiKeyError' examples: invalidApiKey: summary: Invalid API key value: message: Invalid API key accountInactive: summary: Subscription inactive value: code: ACCOUNT_INACTIVE message: >- Your subscription is inactive. Please renew your plan to continue using this feature. apiKeyNotFound: summary: API key not found value: message: API key not found isApiKeyExists: false TooManyRequests: x-inferred: true description: | Rate limit exceeded. Rate limits are applied at the company level; the response body below is inferred because the current documentation mentions handling 429 responses but does not publish a body. Retry with exponential backoff. content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: rateLimited: summary: Rate limit exceeded (inferred example) value: error: code: RATE_LIMIT_EXCEEDED type: validation_error message: Too many requests. Please retry with exponential backoff. InternalError: description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: internalError: summary: Internal error value: error: code: INTERNAL_ERROR type: internal_error message: Something went wrong. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: | 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. ````