Skip to main content

Breathe HR

Introduction​

The Breathe HR source connector connects to the Breathe HR API using an API key.

This connector is currently in development. At this time, authentication can be validated, but data extraction is not yet available.

Setup​

  1. Ensure you have access to the Breathe HR API and an API key.
  2. In Breathe HR, generate or retrieve your API key.
  3. Add the connector in your workspace and provide the required configuration values.

Authentication​

This connector authenticates using an API key sent as an HTTP header:

  • Header: X-API-KEY: <your_api_key>

During connection testing/login, the connector validates credentials by calling:

  • GET https://api.breathehr.com/v1/employees?page=1&per_page=1

Configuration​

FieldTypeRequiredDescription
api_keystringYesYour Breathe HR API key. Sent as the X-API-KEY header on API requests.

Streams​

No streams are currently available.

Although the connector can validate credentials, extraction is not yet implemented and will fail with a message indicating the connector is still in development.