> ## 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. # Create a candidate scheduling link > Generates a unique self-scheduling link for the given entity on this schedule, or returns its existing active link for it rather than creating a duplicate. TapTalent resolves `entityType` + `entityId` against the entity's own record and snapshots its contact details onto the link — you don't supply name/email/phone. Share `data.url` with the candidate yourself (e.g. by email or SMS from your own system); TapTalent does not send it on your behalf. ## OpenAPI ````yaml /api-reference/openapi.yaml post /booking-schedules/{bookingScheduleId}/links 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}/links: post: tags: - Candidate Self-Scheduling summary: Create a candidate scheduling link description: | Generates a unique self-scheduling link for the given entity on this schedule, or returns its existing active link for it rather than creating a duplicate. TapTalent resolves `entityType` + `entityId` against the entity's own record and snapshots its contact details onto the link — you don't supply name/email/phone. Share `data.url` with the candidate yourself (e.g. by email or SMS from your own system); TapTalent does not send it on your behalf. operationId: createBookingLink parameters: - name: bookingScheduleId in: path required: true schema: type: integer example: 501 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateBookingLinkRequest' examples: jobCandidate: summary: Existing job candidate value: entityType: JOB_CANDIDATE entityId: '55021' responses: '200': description: Booking link created or reused. content: application/json: schema: $ref: '#/components/schemas/CreateBookingLinkResponse' examples: created: value: status: success data: id: 8001 token: bkl_9f2c1a7e4d url: https://apply.taptalent.io/book/bkl_9f2c1a7e4d status: ACTIVE entityType: JOB_CANDIDATE entityId: '55021' firstName: Jane lastName: Doe email: jane.doe@example.com phone: '+15551234567' expiresAt: '2026-09-17T00:00:00.000Z' createdAt: '2026-09-10T02:00:00.000Z' '400': description: >- Missing or malformed `entityType`/`entityId`, or the schedule has expired or is soft-deleted. content: application/json: schema: $ref: '#/components/schemas/ApiError' examples: missingEntity: value: error: code: INVALID_REQUEST type: validation_error message: entityType and entityId are required. '401': $ref: '#/components/responses/Unauthorized' '404': description: >- No schedule with this id in your company, or no record found for the given `entityType`/`entityId` 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: CreateBookingLinkRequest: type: object description: | Creates (or, if an active link already exists for this entity on this schedule, returns) a unique self-scheduling link. Identify the entity to book on behalf of with `entityType` + `entityId`; TapTalent resolves the record and snapshots its contact details onto the resulting link — you don't provide name/email/phone yourself. The entity must already exist (e.g. an existing job candidate, sourced via the [Job Candidates](/api-reference/job-candidates) API); this endpoint doesn't create new candidate records. required: - entityType - entityId properties: entityType: type: string description: | Not a fixed enum — known values today are `JOB_CANDIDATE` (`entityId` is a `jobCandidateId` from the [Jobs](/api-reference/jobs)/[Candidates](/api-reference/candidates) APIs), `OUTREACH_CAMPAIGN_CANDIDATE`, and `NOVA_CANDIDATE`. Only `JOB_CANDIDATE` ids are obtainable through this API — the other two types are sourced entirely from TapTalent's own campaign/onboarding flows and have no corresponding lookup here. examples: - JOB_CANDIDATE entityId: type: string description: The id of the entity within `entityType`'s source. Always a string. examples: - '55021' expiresInHours: type: integer description: >- How long the generated link stays valid. Defaults to the schedule's own expiry behavior if omitted. examples: - 168 CreateBookingLinkResponse: type: object required: - status - data properties: status: type: string const: success data: $ref: '#/components/schemas/BookingLink' ApiError: type: object description: Canonical error envelope used by most non-authentication errors. required: - error properties: error: $ref: '#/components/schemas/ApiErrorBody' BookingLink: type: object required: - id - token - url - status - entityType - entityId properties: id: type: integer description: Unique identifier of the booking link. token: type: string description: Opaque token embedded in `url`. url: type: string format: uri description: The full self-scheduling URL to share with the candidate. status: type: string description: | `ACTIVE` while awaiting a booking; `LOCKED` once the candidate has booked; `REVOKED` if invalidated; `REPLACED` if superseded by a newer link for the same candidate and schedule. enum: - ACTIVE - LOCKED - REVOKED - REPLACED entityType: type: string description: | How this candidate was identified. Not a fixed enum — model whatever TapTalent produces; known values today are `JOB_CANDIDATE` (an existing job applicant — `entityId` matches a `jobCandidateId` from the [Jobs](/api-reference/jobs)/[Candidates](/api-reference/candidates) APIs), `OUTREACH_CAMPAIGN_CANDIDATE` (sourced from an outreach campaign flow, company-scoped or private), and `NOVA_CANDIDATE` (a candidate created through TapTalent's Agentic Onboarding flow, with no job or campaign attached). Only `JOB_CANDIDATE` has a matching lookup elsewhere in this API, via the Jobs/Candidates endpoints — treat `OUTREACH_CAMPAIGN_CANDIDATE` and `NOVA_CANDIDATE` ids as opaque. Always present; this link's own `id` (and, once booked, the resulting booking's `id`) remains the reliable way to correlate a candidate across calls regardless of `entityType`. examples: - JOB_CANDIDATE entityId: type: string description: | The id of the underlying record within `entityType`'s source — not necessarily a "candidate" record (e.g. a lead, for `OUTREACH_CAMPAIGN_CANDIDATE`). Always a string — some sources use ids too large to round-trip safely as a JSON number. examples: - '55021' firstName: type: - string - 'null' description: >- Snapshotted from the resolved entity's own record at creation time, not supplied by the caller. lastName: type: - string - 'null' email: type: - string - 'null' format: email phone: type: - string - 'null' expiresAt: type: - string - 'null' format: date-time createdAt: type: string format: date-time 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 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 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. ````