Homerun API

14 endpoints for Homerun, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.

Base URL: https://cotlet.dev/api/v1/homerun
Connects with: Your own Homerun account. What your agent can do follows your permissions in Homerun, and a key from an admin is not needed.
Integration page: Homerun

Read (6)

Return data and change nothing in the account.

Homerun Endpoints: Read
Endpoint	Description
GET /jobs	List your jobs with their state and visibility.
GET /jobs/{job_id}	Read one job: its hiring stages, closing date and application form questions.
GET /jobs/{job_id}/candidates	List the candidates of one job, filtered by stage, tag or status.
GET /jobs/{job_id}/candidates/{candidate_id}	Read a candidate profile with answers, ratings, notes and messages.
GET /tags	List the tags your company uses on candidates.
GET /disqualification-reasons	List the reasons you can give when disqualifying a candidate.

Change the account. Calls marked Confirm wait for the user to approve them.

Homerun Endpoints: Write
Endpoint	Description
POST /jobs/{job_id}/candidates/{candidate_id}/note	Add an internal note to a candidate profile.
POST /jobs/{job_id}/candidates/{candidate_id}/tag	Add a tag to a candidate, creating the tag if it does not exist.
DELETE /jobs/{job_id}/candidates/{candidate_id}/tag	Remove a tag from a candidate.
POST /jobs/{job_id}/candidates/{candidate_id}/to-stage/move Confirm	Move a candidate to another hiring stage of the same job.
POST /jobs/{job_id}/candidates/{candidate_id}/to-job/move Confirm	Move a candidate to another job.
POST /jobs/{job_id}/candidates/{candidate_id}/disqualify Confirm	Disqualify a candidate with a reason and choose whether to tell them.
POST /jobs/{job_id}/candidates/{candidate_id}/email Confirm	Send an email to one candidate through Homerun.
PUT /jobs/{job_id}/visibility Confirm	Make an active job public, private or closed.