Skip to main content
Ensure you have Admin privileges for your BreatheHR account.

Getting your API Key

A BreatheHR API key belongs to one environment, either Production or Sandbox.

1

Enable API keys

Sign in to your BreatheHR dashboard, then open Configure > Settings > Integrations > API Setup.

  • Enable the API keys if they are not already enabled.
2

Copy the API key

On the API Setup page, copy the API Key for your environment (Production or Sandbox) across.

1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.