Skip to main content

​
API Reference

This section provides detailed documentation for all available endpoints in the Taptalent Partner API.

​
Base URL

All API requests should be made to: Production: 
https://partner-api.taptalent.io/v1
Staging/Sandbox: 
https://sandbox.partner-api.taptalent.io/v1

​
Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
See API Keys for more information.

​
Request Format

​
Headers

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

​
Query Parameters

Some endpoints support query parameters for filtering and pagination. See individual endpoint documentation for details.

​
Response Format

​
Success Response

Successful requests return a 200 OK status with JSON data. The response structure varies by endpoint: Job Creation Response: 
{
  "id": "job-uuid",
  "title": "Senior Software Engineer",
  "description": "...",
  "status": "DRAFT",
  ...
}
Job Retrieval Response: 
{
  "id": "job-uuid",
  "title": "Senior Software Engineer",
  "city": "San Francisco",
  "state": "California",
  "country": "United States",
  ...
}

​
Error Response

Errors return appropriate HTTP status codes with a structured error format: 
{
  "error": {
    "code": "ERROR_CODE",
    "type": "error_type",
    "message": "Human-readable error message",
    "details": {
      "field": "Specific validation error message"
    }
  }
}
Example Validation Error: 
{
  "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

CodeDescription
200Success
400Bad Request - Invalid request data or validation error
401Unauthorized - Missing or invalid API key
403Forbidden - Inactive subscription or insufficient permissions
404Not Found - Resource doesn’t exist
500Internal Server Error

​
Rate Limiting

Rate limiting information will be available in future API versions. Currently, rate limits are applied at the company level to ensure fair usage.

​
Available Endpoints

​
Jobs

  • Jobs API - Create and retrieve job postings
    • GET /v1/partner/jobs/:jobId - Get job details
    • POST /v1/partner/jobs - Create a new job

​
Candidates

  • Candidates API - Bulk upload resumes and retrieve candidates
    • POST /v1/partner/candidates/bulk/resume - Bulk upload resumes for parsing
    • GET /v1/partner/candidates/batch/:batchId - Get candidates from a batch with pagination

​
Candidates

​
Next Steps