Breathe HR
Service ID: breathehr
Low cost & intuitive cloud-based HR software ideal for growing businesses: Offering many useful features & simple price options.
At a Glance
- Difficulty
- ⚡MODERATEAPI key authentication, where the consumer creates the credential manually
- Authentication
- API KeyAPI key sent in the x-api-key header, not OAuth. The key carries the permissions of the whole Breathe account and does not expire on a schedule.
- Webhooks
- Virtual webhooks (Apideck polls Breathe for employee created, updated and terminated events)
- Partnership Required
- No(Not required. Breathe's partner programme is a commercial referral arrangement for HR consultants and resellers, not a gate on API access.)
- Partnership Application
- Developer Portal↗
- Apideck Credentials
- Not available(Not available: each Breathe API key is tied to one Breathe account, so every consumer supplies their own.)
- Costs
- Included in a Breathe subscription at no extra charge. Consumers need an active plan: Breathe offers a 14-day free trial but no permanent free tier.
- Sandbox Availability
- Available — Access Sandbox↗(Free developer sandbox, available self-service from developer.breathehr.com.)
- Account Type Required
- Any active Breathe account.
- Consumer Access Level
- Account Admin. Only an Admin can switch the API on and read the key.
- Rate Limits
- 60 requests per 60 seconds per Breathe account; beyond that Breathe returns HTTP 429.
Responsibility matrix
| Task | You (Customer) | Your Consumer | Apideck |
|---|---|---|---|
| Maintain an active Breathe subscription | — | ✓ | — |
| Enable the API and retrieve the key | — | ✓ (Admin only) | Instructions provided |
| Enter the API key in Vault | Implement Vault | ✓ | — |
| Store credentials securely | — | — | ✓ |
| Withdraw access | Prompt the consumer | ✓ Regenerates the key | — |
| Build via the Unified API | ✓ | — | Maintains the connector and mappings |
| Connection sync | — | — | ✓ Polls via virtual webhooks |
| Monitor connections | ✓ Via the Apideck Dashboard | — | Logs and alerts |
Environments
- Sandbox
- Breathe keeps sandbox and production separate, with different credentials for each. Sign up free at developer.breathehr.com for a sandbox account: it issues its own sandbox API key and holds isolated test data on a separate host, so you can build and verify the whole integration before a consumer connects.
- Production
- The consumer's live Breathe account issues its own API key, which an Admin retrieves from the account's API settings. Sandbox credentials CANNOT be used with production accounts, or the reverse. Once you switch, you are reading and writing real HR data, so take care with test records.
🚨Important to Know About Breathe HR
- One API key grants full access to the consumer's Breathe account: Breathe has no scoped permissions, and the only way to withdraw access is to regenerate the key. Make clear what the consumer is granting before they hand it over.
- Breathe is a UK-focused SME platform, so its HR data follows UK conventions such as holiday allowances and UK leave types. Expect that shape in the unified model, and check the fit if your integration targets other regions.
📦
4 supported resources
View field mappings, supported operations, and schema details