Skip to main content

Breezy HR

Introduction​

The Breezy HR source connector connects to the Breezy HR API (v3) using an API key.

Setup​

Prerequisites​

  • A Breezy HR account
  • An API key with access to your Breezy HR company data

Create an API key​

Generate or obtain an API key from Breezy HR. The connector authenticates using this key as a Bearer token.

Authentication​

This connector uses Bearer token authentication.

  • Header: Authorization: Bearer <api_key>

During credential validation, the connector calls:

  • GET https://api.breezy.hr/v3/companies

If this request fails, the connector will report a credential validation error.

Configuration​

FieldTypeRequiredDescription
api_keystring✅Breezy HR API key used as a Bearer token for API requests.

Streams​

This connector is currently in development and does not yet support extraction or expose any streams.

  • Catalog discovery currently returns an empty catalog.
  • Sync/extraction is not yet implemented.

Limitations​

  • No streams are available yet.
  • Incremental sync behavior is not available yet.
  • Schema/cursor definitions are not available yet.