API Reference Overview

​

Base URL

https://partner-api.taptalent.io/v1/partner

https://sandbox.partner-api.taptalent.io/v1/partner

​

Authentication

Authorization: Bearer YOUR_API_KEY

​

Request Format

​

Headers

• Authorization: Bearer YOUR_API_KEY - Your API key
• Content-Type: application/json - For POST/PUT requests

​

Query Parameters

​

Response Format

​

Success Response

{
  "id": 12345,
  "title": "Senior Software Engineer",
  "description": "...",
  "status": "DRAFT",
  ...
}

{
  "id": 12345,
  "title": "Senior Software Engineer",
  "city": "San Francisco",
  "state": "California",
  "country": "United States",
  ...
}

​

Error Response

{
  "error": {
    "code": "ERROR_CODE",
    "type": "error_type",
    "message": "Human-readable error message",
    "details": {
      "field": "Specific validation error message"
    }
  }
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "type": "validation_error",
    "message": "One or more fields are invalid.",
    "details": {
      "title": "\"title\" length must be at least 3 characters long"
    }
  }
}

​

HTTP Status Codes

​

Rate Limiting

​

Available Endpoints

​

Jobs

• Jobs API - Create and retrieve job postings
  • GET /jobs - List all jobs with pagination
  • GET /jobs/:jobId - Get job details
  • POST /jobs - Create a new job

​

Candidates

• Candidates API - Manage and retrieve candidate data
  • GET /candidates/list - List candidates with advanced filtering and pagination
  • GET /candidates/:candidateId - Get detailed candidate information
  • POST /candidates/bulk/resume - Bulk upload resumes for parsing
  • GET /candidates/batch/:batchId - Get candidates from a batch with pagination
  • POST /candidates/bulk-fetch - Bulk fetch candidates by IDs

​

Job Candidates

• Job Candidates API - Manage job-specific candidate operations
  • GET /job-candidates/job/:jobId/candidates - Get candidates for a job with pagination and filters
  • POST /job-candidates/bulk-fetch - Bulk fetch job candidates by IDs
  • POST /job-candidates/bulk/resume - Bulk upload resumes for a specific job

​

Candidate Applications

• Candidate Applications - Hosted application pages, application data, and privacy-consent records
  • GET /job-candidates/:jobCandidateId/application - Get application details (form answers, resume URL, consent record)
  • GET /job-candidates/:jobCandidateId/application/consent-document - Get a fresh time-limited URL for the DPA acknowledgment PDF

​

Assessments

• Assessments API - Create and manage voice-based interviews and assessments
  • GET /assessment - List assessments with pagination
  • POST /assessment/audio-interviews - Create a voice-interview assessment
  • GET /assessment/:assessmentId - Get assessment details and questions
  • PUT /assessment/:assessmentId - Update assessment
  • POST /assessment/:assessmentId/questions - Add a question
  • PUT /assessment/:assessmentId/questions/:questionId - Update a question
  • DELETE /assessment/:assessmentId/questions/:questionId - Delete a question
  • POST /assessment/auto-generate - Create assessment with auto-generated questions (from job or role/purpose)
  • POST /assessment/:assessmentId/generate-questions - Generate questions for an existing assessment
  • POST /assessment/:assessmentId/invite - Invite a candidate to take the assessment
  • POST /assessment/:assessmentId/invite/bulk - Invite up to 5,000 candidates in one request
  • GET /assessment/:assessmentId/invite/bulk/:batchId - Get per-candidate outcomes for a bulk invite batch
  • GET /assessment/:assessmentId/candidates - List candidates who completed the assessment
  • GET /assessment/:assessmentId/submissions/:submissionId/report - Get the result report PDF URL
  • GET /assessment/:assessmentId/submissions/:submissionId/share-link - Get the public result link

​

Agentic Onboarding

• Agentic Onboarding API - Enroll candidates into onboarding flows and receive verified documents and report PDFs
  • GET /onboarding/flows - List onboarding flows
  • POST /onboarding/flows/:flowId/candidates - Enroll a candidate into a flow
  • POST /onboarding/flows/:flowId/candidates/bulk - Enroll up to 100 candidates in one request
  • GET /onboarding/candidates/:onboardingCandidateId - Get candidate status and step progress
  • GET /onboarding/candidates - List/filter onboarding candidates (by externalRef, flow, status)
  • GET /onboarding/candidates/:onboardingCandidateId/documents - List documents and reports (PDF URLs)
  • GET /onboarding/candidates/:onboardingCandidateId/documents/:documentId - Get one document with a fresh PDF URL
  • PATCH /onboarding/candidates/:onboardingCandidateId/external-status - Push your system’s status and Employee ID
  • POST /onboarding/candidates/:onboardingCandidateId/terminate - Terminate an enrollment
  • GET /onboarding/offers - List offer documents (filter by job candidate, candidate, job, status)
  • GET /onboarding/offers/:offerId - Get one offer document with signer statuses and fresh signed-PDF URLs

​

Webhook Logs

• Webhook Logs - Monitor and debug webhook deliveries through the dashboard
  • View all webhook deliveries sent to your configured endpoint
  • Filter by event type, status code, and date range
  • Review delivery status, retry attempts, and response data

​

Next Steps

• Explore the Jobs API documentation
• Set up Webhooks for real-time updates
• Review Integration Notes for best practices