HireSquire API

Authentication

The HireSquire API uses Bearer token authentication. Include your API token in the Authorization header of every request.

Getting Your API Token

1. Log in to your HireSquire account
2. Go to Profile Settings
3. Scroll to the API Tokens section
4. Click Create Token and give it a name
5. Copy the token immediately - it won't be shown again!

Base URL

All API requests should be made to the following base URL:

API Endpoints

{
  "title": "Senior Software Engineer",
  "description": "We're looking for a senior software engineer...",
  "leniency_level": 5,
  "resumes": [
    {
      "filename": "john_doe.pdf",
      "content": "John Doe\nSenior Developer\n5 years experience..."
    }
  ],
  "webhook_url": "https://your-app.com/webhooks/hiresquire"
}

{
  "status": "shortlisted"
}

{
  "candidate_id": 123,
  "type": "invite",
  "tone": "professional",
  "custom_notes": "We are excited to meet you!"
}

{
  "job_id": 123,
  "status": "cancelled",
  "message": "Job has been cancelled."
}

{
  "job_id": 123,
  "compared_count": 3,
  "top_candidate": "John Doe",
  "top_score": 92,
  "score_range": 15,
  "candidates": [...]
}

{
  "candidate_id": 123,
  "outcome": "hired" // or "rejected", "withdrawn"
}

{
  "url": "https://your-webhook.com/callback",
  "event": "job.completed"
}

{
  "name": "string",
  "email": "string (email format)",
  "phone": "string",
  "location": "string",
  "experience": [
    {
      "company": "string",
      "title": "string",
      "start_date": "YYYY-MM-DD",
      "end_date": "YYYY-MM-DD or null",
      "description": "string"
    }
  ],
  "education": [
    {
      "institution": "string",
      "degree": "string",
      "field": "string",
      "graduation_date": "YYYY-MM-DD"
    }
  ],
  "skills": ["string"],
  "certifications": ["string"]
}

Webhooks

Configure webhooks to receive real-time notifications when events occur in your HireSquire account.

Available Events

Webhook Payload

{
  "event": "job.completed",
  "job_id": 123,
  "job_title": "Senior PHP Developer",
  "timestamp": "2026-05-01T10:30:00Z",
  "status": "completed",
  "summary": {
    "total_candidates": 10,
    "qualified_count": 3,
    "top_score": 92,
    "average_score": 65
  },
  "top_candidates": [
    {
      "id": 1,
      "name": "John Doe",
      "score": 92,
      "summary": "Excellent fit..."
    }
  ],
  "results_url": "https://hiresquireai.com/api/v1/jobs/123/results"
}

Security & Signature Verification

All webhook requests include a X-Webhook-Signature header. You should verify this signature to ensure the request came from HireSquire.

$signature = $request->header('X-Webhook-Signature');
list($t, $v1) = explode(',', $signature);
$timestamp = str_replace('t=', '', $t);
$hash = str_replace('v1=', '', $v1);

$signedPayload = $timestamp . '.' . $request->getContent();
$expectedHash = hash_hmac('sha256', $signedPayload, $webhookSecret);

if (hash_equals($expectedHash, $hash)) {
    // Signature is valid
}

Conditional Webhooks

Filter which webhook events are triggered based on candidate scores or rank. Add webhook_conditions to your job submission:

{
  "title": "Senior Developer",
  "description": "Looking for...",
  "webhook_url": "https://your-app.com/webhook",
  "webhook_conditions": {
    "min_score": 80,
    "only_top_n": 5,
    "events": ["job.completed", "high_score_detected"]
  }
}

Code Examples

# Create a job posting
curl -X POST "https://hiresquireai.com/api/v1/jobs" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Senior Software Engineer",
    "description": "Looking for a Python developer with 5+ years experience...",
    "resumes": [
      {"filename": "resume.pdf", "content": "John Doe\nExperience..."}
    ]
  }'

const response = await fetch('https://hiresquireai.com/api/v1/jobs', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Senior Software Engineer',
    description: 'Looking for a Python developer with 5+ years experience...',
    resumes: [
      { filename: 'resume.pdf', content: 'John Doe\nExperience...' }
    ]
  })
});

const data = await response.json();
console.log(data);

import requests

url = "https://hiresquireai.com/api/v1/jobs"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "title": "Senior Software Engineer",
    "description": "Looking for a Python developer with 5+ years experience...",
    "resumes": [
        {"filename": "resume.pdf", "content": "John Doe\nExperience..."}
    ]
}

response = requests.post(url, json=data, headers=headers)
print(response.json())

Error Handling

The API uses standard HTTP status codes to indicate success or failure.

Rate Limits

API requests are rate limited to ensure fair usage and system stability.

Rate limit information is included in response headers:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1640995200

Agent API Keys

Create dedicated API keys for AI agents with built-in spend limits. Perfect for controlling costs while allowing agents to operate autonomously.

Create Agent Key

{
  "name": "My Agent",
  "daily_spend_limit": 5.00,
  "monthly_spend_limit": 100.00,
  "lifetime_spend_limit": null,
  "permissions": ["read", "write", "screen", "email", "bulk"]
}

All Endpoints

Prepaid Credits

Purchase prepaid credits for pay-as-you-go agent usage. No subscription required.

Credit Satchels

Credit Endpoints

Auto-Reload

Enable auto-reload to automatically purchase more credits when your balance falls below:

• $1 (minimum threshold)
• 5% of your largest single purchase (whichever is higher)

Usage Webhook Events

Official Repositories

Calendar & Meeting Integrations

Automate interview scheduling by connecting calendar and meeting tools.

Advanced: API Integrations (Optional)

For automatic status updates when candidates book, connect via API:

Supported Tools

API Endpoints

GET|POST|DELETE /api/v1/calendar/connections

GET /api/v1/calendar/slots?provider=calendly&date=2026-04-27

POST /api/v1/interviews
{
  "job_id": 123,
  "candidate_id": 456,
  "scheduled_at": "2026-04-28T10:00:00Z"
}

POST /api/v1/meetings/links
{
  "provider": "calendly",
  "topic": "Interview with John Doe"
}

Quick Setup

Recommended: Add your public calendar link in Profile Settings (works with Calendly, Cal.com, Google, Teams, etc.)

Advanced: Navigate to Profile → Integrations for API-based connections with webhook support.

Advanced Tutorials & Case Studies