# Homerun Public API API

> Homerun Public API API on Apizie: 11 endpoints (Get a list of job applications, Create new job applications, Get detailed information of a job application, Update job application properties, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/security:homerun/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `security:homerun`
- Category: Security
- Status: byok
- Source: https://homerun.co
- Page: https://apizie.tech/api/security/homerun
- OpenAPI: https://apizie.tech/api/security/homerun/openapi.json

# Introduction Welcome to the Homerun API! You can use our API to programmatically access your jobs and applicants in Homerun. ## Authentication All API endpoints require Bearer authentication. We'll reference this…

## Endpoints

### Get a list of job applications
`GET https://apizie.tech/v1/security:homerun/job-applications-list-of-applications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | object | no | Filter by one of the fields |
| include | array | no | Include additional information in the response |
| page | integer | no | Change the page number to get more results |
| perPage | integer | no | Change the number of object returned per page |

### Create new job applications
`POST https://apizie.tech/v1/security:homerun/job-applications-add-new-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get detailed information of a job application
`GET https://apizie.tech/v1/security:homerun/job-applications-detailed-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| job_application_id | string | yes | Job Application ID |
| include | array | no | Include additional information in the response |

### Update job application properties
`POST https://apizie.tech/v1/security:homerun/job-applications-update-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| job_application_id | string | yes | Job Application ID |
| body | object | yes | JSON request body |

### Delete a job application
`POST https://apizie.tech/v1/security:homerun/job-applications-remove-job-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| job_application_id | string | yes | Job Application ID |

### Create a new note
`POST https://apizie.tech/v1/security:homerun/job-application-notes-create-new-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| job_application_id | string | yes | Job Application ID |
| body | object | yes | JSON request body |

### Upload files to a job application
`POST https://apizie.tech/v1/security:homerun/job-application-files-upload-files-to-job-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| job_application_id | string | yes | Job Application ID |
| body | object | yes | Form fields as a JSON object |

### Upload an applicant photo
`POST https://apizie.tech/v1/security:homerun/job-application-files-upload-photo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| job_application_id | string | yes | Job Application ID |
| body | object | yes | Form fields as a JSON object |

### Get a list of vacancies
`GET https://apizie.tech/v1/security:homerun/vacancies-list-of-vacancies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | object | no | Name of the vacancy status |
| include | array | no | Include additional information in the response |
| page | integer | no | Change the page number to get more results |
| perPage | integer | no | Change the number of object returned per page |

### Get detailed information of a vacancy
`GET https://apizie.tech/v1/security:homerun/vacancies-detailed-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| vacancy_id | string | yes | Vacancy ID |
| include | array | no | Include additional information in the response |

### Dummy endpoint for testing authentication
`GET https://apizie.tech/v1/security:homerun/other-dummy-endpoint` (byok)

## Example
```
curl "https://apizie.tech/v1/security:homerun/job-applications-list-of-applications" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Homerun Public API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/security:homerun/job-applications-list-of-applications with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Homerun Public API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Homerun Public API itself also needs your own key from api.homerun.co.

### Can AI agents use the Homerun Public API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key security:homerun.

### What is the status of the Homerun Public API API?
Needs your own provider key (bring your own key)