Breezy API

By Abhishek Kumar
3 min read
Integrate Breezy’s recruiting features with REST APIs. Manage candidates, jobs, and interviews, and get real-time updates via webhooks. Rate limits ensure stability.

Table of Contents

A uniquely simple, visual recruiting tool and applicant tracking system.

API Overview

Breezy is a modern recruiting platform that streamlines the hiring process for businesses of all sizes. It offers a suite of features designed to make recruiting more efficient and effective, including applicant tracking, candidate sourcing, interview scheduling, and reporting. Breezy's intuitive interface and powerful automation tools make it easy for recruiters to manage their entire hiring workflow from a single platform. With Breezy, businesses can save time and resources while finding and hiring the best talent for their teams.

Breezy API provides a comprehensive set of RESTful APIs that allow developers to integrate Breezy's functionality into their own applications. The API documentation is extensive and easy to follow, making it simple for developers to get started. The APIs cover a wide range of functionality, including candidate management, job management, interview scheduling, and reporting. Breezy also supports webhooks, which allow developers to receive real-time notifications of events that occur within the Breezy platform. To ensure the stability and reliability of the API, Breezy implements rate limits to prevent excessive usage. This ensures that all users have a fair and consistent experience when using the Breezy API.

API Request Limits

Free

100 requests per minute

Starter

1,000 requests per minute

Growth

5,000 requests per minute

Professional

10,000 requests per minute

Enterprise

20,000 requests per minute

SDKs

APIs

Candidate

Method: POST

Description: .

Endpoint:

Parameters: first_name, last_name, email

Candidate

Method: GET

Description: .

Endpoint:

Parameters: id

Candidate

Method: PUT

Description: .

Endpoint:

Parameters: id, first_name, last_name, email

Candidate

Method: DELETE

Description: .

Endpoint:

Parameters: id

Job

Method: POST

Description: .

Endpoint:

Parameters: title, description, location, salary

Job

Method: GET

Description: .

Endpoint:

Parameters: id

Job

Method: PUT

Description: .

Endpoint:

Parameters: id, title, description, location, salary

Job

Method: DELETE

Description: .

Endpoint:

Parameters: id

Application

Method: POST

Description: .

Endpoint:

Parameters: candidate_id, job_id, resume, cover_letter

Application

Method: GET

Description: .

Endpoint:

Parameters: id

Application

Method: PUT

Description: .

Endpoint:

Parameters: id, candidate_id, job_id, resume, cover_letter

Application

Method: DELETE

Description: .

Endpoint:

Parameters: id

Interview

Method: POST

Description: .

Endpoint:

Parameters: candidate_id, job_id, interviewer_id, date, time

Interview

Method: GET

Description: .

Endpoint:

Parameters: id

Interview

Method: PUT

Description: .

Endpoint:

Parameters: id, candidate_id, job_id, interviewer_id, date, time

Interview

Method: DELETE

Description: .

Endpoint:

Parameters: id

Offer

Method: POST

Description: .

Endpoint:

Parameters: candidate_id, job_id, salary, benefits, start_date

Offer

Method: GET

Description: .

Endpoint:

Parameters: id

Offer

Method: PUT

Description: .

Endpoint:

Parameters: id, candidate_id, job_id, salary, benefits, start_date

Offer

Method: DELETE

Description: .

Endpoint:

Parameters: id

FAQ

How do I get started with the Breezy APIs?

Sign up for a developer account at https://developer.breezy.hr/ and obtain your API key.

What are the authentication methods supported by the Breezy APIs?

The Breezy APIs use OAuth 2.0 for authentication. You will need to obtain an access token using your API key.

What are the rate limits for the Breezy APIs?

The Breezy APIs have rate limits in place to ensure the stability and performance of the service. The specific rate limits vary depending on the API endpoint.

How do I create a sandbox account for testing the Breezy APIs?

You can create a sandbox account by signing up for a free trial at https://www.breezy.hr/.

What is the difference between a developer account and a regular Breezy account?

A developer account is specifically designed for developers who want to integrate with the Breezy APIs. It provides access to the API documentation, SDKs, and other developer resources.

Last Update: September 13, 2024