API Documentation

This guide provides all the information you need to begin integrating your applications with easyhire's capabilities. Below, you will find detailed descriptions of our API endpoints, authentication methods, and comprehensive examples to get you started quickly.

Authentication

To use the easyhire's API, you need an API key. Here is how you can obtain and use your key:

To obtain an API key, head to our main Integrations page:

Click Here

- Use the API key in your request header: "Authorization: Api-Key {your_api_key}"

Note on Zapier

If you are looking to integrate with Zapier, this would be the API key you provide when connecting your easyhire account on Zapier

Quick Start Guide

Here’s a quick example to create an application using our API:

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Api-Key your_api_key" \
  -d '{
    "job_opening_id": your_job_opening_id_on_easyhire,
    "applicant_email": "applicant@example.com",
    "applicant_name": "John Doe",
    "resume_pdf": "http://example.com/resume.pdf",
    "unique_external_id": "12345"
  }' \
  https://easyhire.ai/api/create-application

In the above, you would retrieve your unique Job Opening ID from a given job opening you created on easyhire. This would look something like this 'eac97593-0f38-4049-b4d9-f02bd44c7e8e' and can be found when clicking to view details for a given opening.

You can pass through the resume as either a PDF file, in which case use multipart/form as the content-type, or as the URL.

Endpoints

Create Application

This endpoint allows you to create a new application. It accepts a POST request with the following parameters:

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Api-Key your_api_key" \
  -d '{
    "job_opening_id": your_job_opening_id_on_easyhire,
    "applicant_email": "applicant@example.com",
    "applicant_name": "John Doe",
    "resume_pdf": "http://example.com/resume.pdf",
    "unique_external_id": "12345"
  }' \
  https://easyhire.ai/api/create-application

Get User Info

This endpoint allows you to retrieve information about the user associated with an API key. It accepts a GET request:

curl -X GET \
  -H "Authorization: Api-Key your_api_key" \
  https://easyhire.ai/api/auth/

Error Handling

Understanding how our API communicates errors is crucial for a smooth integration:

{
  "error": "NotFound",
  "message": "The requested resource was not found.",
  "status": 404
}

Rate Limiting

To ensure the quality of service, our API enforces rate limits. Current limits are 100 requests per minute per user. Exceeding these limits will result in a temporary ban.

Versioning

We use a simple versioning system to ensure backwards compatibility. Specify the API version in your header:

-H "Accept-Version: v1"

Contact and Support

If you have any questions or require further assistance, please contact our support team at support@easyhire.ai