API DOCUMENTATION

Powerful API for Developers

Integrate NiceHire's AI-powered hiring capabilities into your applications with our comprehensive REST API and webhooks.

Try API Explorer

50+

API Endpoints

99.9%

API Uptime

< 100ms

Average Latency

24/7

Developer Support

Documentation

Getting Started

Authentication

All API requests require authentication using your API key. Include it in the Authorization header:

 curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.nicehire.ai/v1/interviews

Base URL

https://api.nicehire.ai/v1

Rate Limiting

API requests are limited to 1000 requests per hour per API key. Rate limit headers are included in all responses.

Core Endpoints

POST/v1/interviews

Create a new AI interview session for a candidate.

Request Body:

{
  "candidate": {
    "name": "John Doe",
    "email": "john@example.com"
  },
  "position": {
    "title": "Software Engineer",
    "requirements": ["JavaScript", "React", "Node.js"]
  },
  "interview_type": "technical",
  "duration_minutes": 30
}

GET/v1/jobs

Retrieve a list of all job postings for your organization.

Response Example:

{
  "jobs": [
    {
      "id": "job_123",
      "title": "Senior Frontend Developer",
      "status": "active",
      "applications_count": 42,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 15,
  "page": 1
}

GET/v1/candidates/{id}

Retrieve detailed information about a specific candidate, including AI analysis results.

Webhooks

Receive real-time notifications when events occur in your NiceHire account.

Available Events

interview.completed

Triggered when an AI interview session is completed

interview.scheduled

Triggered when a live interview is scheduled

application.received

Triggered when a new job application is submitted

candidate.analyzed

Triggered when AI analysis of a candidate is complete

job.published

Triggered when a new job posting is published

offer.sent

Triggered when a job offer is sent to a candidate

Webhook Setup

 curl -X POST https://api.nicehire.ai/v1/webhooks \
   -H "Authorization: Bearer YOUR_API_KEY" \
   -H "Content-Type: application/json" \
   -d '{
     "url": "https://your-app.com/webhooks",
     "events": ["interview.completed", "application.received"]
   }'