​
Overview

The HirePanda API enables you to integrate our AI-powered hiring platform into your applications and workflows. Build custom integrations, automate workflows, and access your hiring data programmatically.
Base URL: https://api.hirepanda.com/api/v1
Current Version: v1
Protocol: HTTPS only

​
Quick Start

1

Get Your API Key

Generate an API key from your dashboard settings
2

Make Your First Request

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.hirepanda.com/api/v1/jobs
3

Explore Endpoints

Use our interactive API explorer or check the endpoint documentation

​
Authentication

All API requests require authentication using a Bearer token in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
Keep your API keys secure and never expose them in client-side code. Use environment variables and rotate keys regularly.

​
API Key Management

Key Features:
  • Multiple keys per account
  • Granular permissions
  • Usage tracking
  • Key rotation support
Best Practices:
  • Use different keys for different environments
  • Implement key rotation every 90 days
  • Monitor key usage in analytics
  • Revoke unused keys immediately

​
Rate Limiting

To ensure fair usage and platform stability:

Standard Limits

  • 1,000 requests per hour
  • 10,000 requests per day
  • 100 concurrent requests

Enterprise Limits

  • 10,000 requests per hour
  • 100,000 requests per day
  • 1,000 concurrent requests
Rate Limit Headers: 
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

​
Request Format

​
Headers

Required headers for all requests: 
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json

​
Request Body

All POST/PUT requests should send JSON: 
{
  "job": {
    "title": "Senior Software Engineer",
    "department": "Engineering",
    "location": "Remote"
  }
}

​
Response Format

​
Successful Response

{
  "data": {
    "id": "job_123",
    "title": "Senior Software Engineer",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

​
Error Response

{
  "error": {
    "code": "validation_error",
    "message": "Invalid request parameters",
    "details": {
      "title": "Title is required"
    }
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

​
Common Patterns

​
Pagination

List endpoints support pagination: 
GET /api/v1/jobs?page=2&per_page=50
Pagination Response: 
{
  "data": [...],
  "meta": {
    "current_page": 2,
    "per_page": 50,
    "total_pages": 10,
    "total_count": 500
  }
}

​
Filtering

Use query parameters for filtering: 
GET /api/v1/candidates?status=active&score_min=80

​
Sorting

Sort results using the sort parameter: 
GET /api/v1/jobs?sort=-created_at,title
Use - prefix for descending order.

​
Field Selection

Request specific fields only: 
GET /api/v1/jobs?fields=id,title,status

​
Data Types

​
Common Fields

FieldTypeDescription
idstringUnique identifier (UUID)
created_atdatetimeISO 8601 timestamp
updated_atdatetimeISO 8601 timestamp
statusenumObject status

​
Enumerations

Job Status:
  • draft - Not yet published
  • active - Accepting applications
  • paused - Temporarily inactive
  • closed - No longer accepting
Candidate Status:
  • new - Just applied
  • screening - Taking assessment
  • review - Under review
  • interview - Interview stage
  • offer - Offer extended
  • hired - Offer accepted
  • rejected - Not moving forward

​
Webhooks

Set up webhooks to receive real-time updates: 
POST /api/v1/webhooks
{
  "url": "https://your-app.com/webhook",
  "events": ["application.created", "assessment.completed"],
  "secret": "your_webhook_secret"
}
Learn more about webhooks →

​
SDKs & Libraries

Official SDKs for popular languages: 
npm install @hirepanda/sdk

​
API Explorer

Try out API endpoints directly in your browser:

Interactive API Explorer

Test endpoints with your API key in a safe environment

​
Environments

EnvironmentBase URLPurpose
Productionhttps://api.hirepanda.com/api/v1Live data
Sandboxhttps://sandbox-api.hirepanda.com/api/v1Testing
Use the sandbox environment for development and testing. It provides full API functionality with test data that resets daily.

​
Versioning

API versions are included in the URL path:
  • Current: /api/v1/
  • Legacy: /api/v0/ (deprecated)
Version Policy:
  • New versions for breaking changes only
  • Minimum 6-month deprecation notice
  • Version sunset after 12 months
  • Clear migration guides provided

​
Support

API Status

Real-time API health

Changelog

Latest updates

Support

Technical assistance

​
Next Steps

1

Authentication

Set up authentication and get your API key
2

Create a Job

Post your first job via the API
3

Manage Candidates

Track candidates through your pipeline
4

Set Up Webhooks

Configure webhooks for real-time updates