Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Breezy HR API
version: '2026-10-15'
description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-15: 2 operation(s) read from 3 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Breezy HR has published no machine-readable contract that the pipeline could find. Engine: local.'
x-evidence-tiers:
code-example: 2
documentation: 0
pages-with-code: 2
pages-read: 3
x-generated-from: documentation
x-provenance: generated
x-authored-by: API Evangelist
x-generated: '2026-10-15'
x-generator: generate-contract-from-docs.py
x-engine: local
x-sources:
- https://developer.breezy.hr/reference/webhooks
- https://developer.breezy.hr/reference/authorization
- https://developer.breezy.hr/reference/updatecandidate
servers:
- url: https://api.breezy.hr
security:
- apiKey: []
tags:
- name: Breezy HR API
paths:
/v3/{v3id}:
get:
operationId: get_v3_v3id
tags:
- Breezy HR API
summary: GET /v3/companies
x-source: https://developer.breezy.hr/reference/authorization
parameters:
- name: v3id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: code-example
language: curl
snippet: "curl curl https://api.breezy.hr/v3/companies -H \"Authorization: breezy_pat_your_token_here\" \n HTTP GET /v3/companies HTTP/1.1\nHost: api.breezy.hr\nAuthorization: breezy_pat_your_token_here \n NOTE : PATs have the prefix breezy pat and are only shown once — Copy and store yours securely before closing the dialog. \n Session Tokens \n Obtain a session token by calling POST /v3/signin with your email an"
collapsed_from: 2 example path(s) differing only at v3Id
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: Authorization