Home

API Documentation

Integrate Require Hire's powerful recruitment features into your applications

REST API
Quick Links

API Overview

The Require Hire API provides programmatic access to our interview-first recruitment platform, allowing you to integrate our services seamlessly into your applications.

Base URL: https://requirehire.com/api/v1
Key Features
  • RESTful API design with JSON responses
  • OAuth 2.0 authentication
  • Rate limiting for fair usage
  • Comprehensive error handling
  • Real-time webhooks for events

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY
Getting Your API Key
  1. Log in to your Require Hire account
  2. Navigate to Settings → API Keys
  3. Click "Generate New API Key"
  4. Copy and securely store your key
Security: Never share your API key or commit it to version control. Treat it like a password.

API Endpoints

Candidates
Method Endpoint Description
GET /candidates List all candidates
GET /candidates/:id Get candidate details
POST /candidates Create new candidate
PUT /candidates/:id Update candidate
DELETE /candidates/:id Delete candidate
Job Postings
Method Endpoint Description
GET /jobs List all job postings
GET /jobs/:id Get job details
POST /jobs Create job posting
PUT /jobs/:id Update job posting
Interviews
Method Endpoint Description
GET /interviews List all interviews
POST /interviews Schedule interview
PUT /interviews/:id Update interview
POST /interviews/:id/feedback Submit interview feedback
Example Request
curl -X GET "https://requirehire.com/api/v1/candidates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Example Response
{
  "status": "success",
  "data": {
    "candidates": [
      {
        "id": 123,
        "name": "John Doe",
        "email": "john@example.com",
        "skills": ["Python", "Django", "React"],
        "experience_years": 5,
        "location": "Mumbai, India"
      }
    ],
    "total": 1,
    "page": 1
  }
}

Error Handling

The API uses conventional HTTP status codes to indicate success or failure:

Status Code Meaning
200 Success - Request completed successfully
201 Created - Resource created successfully
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid or missing API key
404 Not Found - Resource doesn't exist
429 Too Many Requests - Rate limit exceeded
500 Server Error - Something went wrong on our end
Error Response Format
{
  "status": "error",
  "message": "Invalid API key",
  "code": "INVALID_API_KEY"
}

Rate Limits

To ensure fair usage and platform stability, API requests are rate-limited based on your plan:

Plan Rate Limit
Basic 100 requests per hour
Professional 1,000 requests per hour
Enterprise 10,000 requests per hour
Rate Limit Headers

Each API response includes headers with rate limit information:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Need Help with Integration?

Our developer support team is here to help you integrate Require Hire's API into your applications.

Contact Support Help Center