# Breezy HR API Settings API

> Breezy HR API Settings API on Apizie: 50 endpoints (/signin, /signout, /user, /user/details, …) 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://www.apizie.tech/v1/business:breezy-hr/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:breezy-hr`
- Category: Business
- Status: byok
- Source: https://breezy.hr
- Page: https://www.apizie.tech/api/business/breezy-hr
- OpenAPI: https://www.apizie.tech/api/business/breezy-hr/openapi.json

We specialize in sourcing high quality pilots to meet the needs of 135 operators. Our team of highly skilled pilots and aviation experts seamlessly integrates with your operation to quickly provide you with world-class…

## Endpoints

### /signin
`POST https://www.apizie.tech/v1/business:breezy-hr/authentication-get-access-token` (byok)

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

### /signout
`GET https://www.apizie.tech/v1/business:breezy-hr/session-invalidate-token` (byok)

### /user
`GET https://www.apizie.tech/v1/business:breezy-hr/user-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | no | user id to lookup (if blank look up by auth token) |

### /user/details
`GET https://www.apizie.tech/v1/business:breezy-hr/user-get-company-details` (byok)

### /company/:id/
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |

### /company/:id/custom-attributes/candidate
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-candidate-custom-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |

### /company/:id/custom-attributes/position
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-position-custom-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |

### /company/:id/pipeline/:id
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-pipeline-stages-by-pipeline-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| pipeline_id | string | yes | pipeline id |

### /company/:id/pipelines
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-pipelines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |

### /company/:id/questionnaire/:id
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-questionnaire-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| questionnaire_id | string | yes |  |

### /company/:id/questionnaires
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-questionnaires` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |

### /company/:id/template/:id
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-email-template-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| template_id | string | yes | template id |

### /company/:id/templates
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-all-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |

### /companies
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-associated` (byok)

### ./position/:id
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-position-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| position_id | string | yes | position id |

### ./position/:id
`POST https://www.apizie.tech/v1/business:breezy-hr/company-update-position-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| body | object | no | JSON request body |

### ./position/:id/state
`POST https://www.apizie.tech/v1/business:breezy-hr/company-update-position-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| body | object | no | JSON request body |

### ./position/:id/stream
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-position-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company |
| position_id | string | yes | position id |

### ./position/:id/team
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-position-team-members` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| position_id | string | yes | position id |

### ./positions
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-positions-by-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| state | string | no | Specify an optional position state filter. e.g. draft, archived, published, closed, pending |
| company_id | string | yes | company id |

### ./positions
`POST https://www.apizie.tech/v1/business:breezy-hr/company-create-new-position` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| body | object | no | JSON request body |

### ./position/:id/custom-fields
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-position-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| position_id | string | yes | position id |

### ./position/:id/custom-fields/:id
`POST https://www.apizie.tech/v1/business:breezy-hr/company-update-custom-field` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| position_id | string | yes | position id |
| custom_field_id | string | yes | custom field id |
| body | object | no | JSON request body |

### ./candidate/:id
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-candidate-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| position_id | string | yes | position id |
| candidate_id | string | yes | candidate id |

### ./candidate/:id
`POST https://www.apizie.tech/v1/business:breezy-hr/company-update-candidate-position` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidate/:id/assessments
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-assessments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| position_id | string | yes | position id |
| candidate_id | string | yes | candidate id |

### ./candidate/:id/background-checks
`GET https://www.apizie.tech/v1/business:breezy-hr/background-check-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| position_id | string | yes | position id |
| candidate_id | string | yes | candidate id |

### ./candidate/:id/conversation
`GET https://www.apizie.tech/v1/business:breezy-hr/conversation-get-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company _id |
| position_id | string | yes | position id |
| candidate_id | string | yes | candidate id |
| include_delayed | integer | no | 1 to include any messages that are currently queued for delayed delivery |
| skip | integer | no | Number of records to skip for paging |

### ./candidate/:id/conversation
`POST https://www.apizie.tech/v1/business:breezy-hr/conversation-add-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidate/:id/custom-attribute
`POST https://www.apizie.tech/v1/business:breezy-hr/custom-attribute-add-to-candidate-custom-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidate/:id/documents
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-candidate-documents-by-position` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |

### ./candidate/:id/documents
`POST https://www.apizie.tech/v1/business:breezy-hr/company-add-candidate-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |

### ./candidate/:id/education
`POST https://www.apizie.tech/v1/business:breezy-hr/company-add-education-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidate/:id/meta
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-position-candidate-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |

### ./candidate/:id/move
`POST https://www.apizie.tech/v1/business:breezy-hr/company-move-candidate-to-position` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidate/:id/questionnaire/:id
`POST https://www.apizie.tech/v1/business:breezy-hr/questionnaire-save-candidate-responses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| candidate_questionnaire_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidate/:id/questionnaires
`GET https://www.apizie.tech/v1/business:breezy-hr/questionnaire-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |

### ./candidate/:id/resume
`POST https://www.apizie.tech/v1/business:breezy-hr/company-attach-resume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidate/:id/scorecard
`POST https://www.apizie.tech/v1/business:breezy-hr/company-update-candidate-scorecard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidate/:id/send-questionnaire
`POST https://www.apizie.tech/v1/business:breezy-hr/questionnaire-create-for-candidate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| questionnaire_id | string | yes |  |
| email_candidate | boolean | no | should the result of this action send an email to the candidate to complete questionnaire |

### ./candidate/:id/stage
`POST https://www.apizie.tech/v1/business:breezy-hr/company-move-candidate-stage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidate/:id/stream
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-position-candidate-stream-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |

### ./candidate/:id/stream
`POST https://www.apizie.tech/v1/business:breezy-hr/company-add-candidate-stream-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidate/:id/work-history
`POST https://www.apizie.tech/v1/business:breezy-hr/work-history-add-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| candidate_id | string | yes |  |
| body | object | no | JSON request body |

### ./candidates
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-position-candidates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| page_size | integer | no | Add this parameter to force paging of results (max: 50) |
| page | integer | no | If page size is passed, this determines which page of data will be returned |
| sort | string | no | Determines the sort order of the data returned. Can be (created / updated) |

### ./candidates
`POST https://www.apizie.tech/v1/business:breezy-hr/company-add-new-candidate-to-position` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| stage_actions_enabled | boolean | no | When origin is "sourced", should stage actions be executed (defaults to false). This is always true when origin is "applied" |
| body | object | no | JSON request body |

### ./candidates/resume
`POST https://www.apizie.tech/v1/business:breezy-hr/company-upload-resume` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes |  |
| position_id | string | yes |  |
| stage_id | string | no | id of pipeline stage to put new candidate in |
| stage_actions_enabled | boolean | no | execute stage actions configured on stage candidate is being created in |
| body | object | no | JSON request body |

### ./candidates/search
`GET https://www.apizie.tech/v1/business:breezy-hr/company-get-candidates-by-email` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| email_address | string | yes |  |

### ./candidate/:id/custom-fields
`GET https://www.apizie.tech/v1/business:breezy-hr/custom-field-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| position_id | string | yes | position id |
| candidate_id | string | yes | candidate id |

### ./candidate/:id/custom-fields/:id
`POST https://www.apizie.tech/v1/business:breezy-hr/custom-field-update-candidate-custom-fields` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| company_id | string | yes | company id |
| position_id | string | yes | position id |
| candidate_id | string | yes | candidate id |
| custom_field_id | string | yes | custom field id |
| body | object | no | JSON request body |

## Example
```
curl "https://www.apizie.tech/v1/business:breezy-hr/authentication-get-access-token" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Breezy HR API Settings API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/business:breezy-hr/authentication-get-access-token with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Breezy HR API Settings API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Breezy HR API Settings itself also needs your own key from api.breezy.hr.

### Can AI agents use the Breezy HR API Settings API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:breezy-hr.

### What is the status of the Breezy HR API Settings API?
Needs your own provider key (bring your own key)