Menu

Samenvatting van de Breathe HR API

De Breathe HR REST API is opgebouwd rond 23 resource-schema's die samen alle kernmodules van het HR-platform afdekken. Elke resource heeft een eigen Swagger 1.2-specificatie, met uniforme CRUD-operaties en een aparte sandbox-omgeving voor veilige ontwikkeling.
  • Medewerker-administratie: Beheer employees, employee_jobs, departments, divisions, locations en working_patterns voor consistentie met je HRIS of organigram.
  • Verlof en ziekte: Uitgebreide dekking met absences (incl. cancel), leave_requests, sicknesses, holiday_allowances en statutory_holiday_countries — compleet voor Britse regelgeving.
  • Beloning en benefits: Haal salaries, bonuses en benefits op voor koppeling met payroll-providers.
  • Declaraties: Uitgebreid declaratiemodel met employee_expense_claims (CRUD) en employee_expenses voor bonnetjes-niveau-detail.
  • Trainingen: Synchroniseer company_training_types en employee_training_courses met LMS- of compliance-tools.
  • Wijzigingsverzoeken: change_requests voor goedkeuringsflows op contract- en salariswijzigingen; per afdeling ook `/departments/{id}/absences|salaries|bonuses|benefits` voor granulaire toegang."
API Quick Facts REST
  • Authenticatie API Key
  • Methods GET (43)POST (11)PUT (4)DELETE (4)
  • Rate limits Documented on developer.breathehr.com/documentation/rate_limiting
  • Webhooks Niet beschikbaar
  • Sandbox Beschikbaar
  • Response format JSON
  • Versionering URL-based

Laatste ontwikkelingen bij de Breathe HR API

Breathe HR biedt al jaren een publieke REST API v1 onder `api.breathehr.com/v1`. De API is gedocumenteerd in Swagger 1.2-formaat met 23 gescheiden resource-schema's op het sandbox-domein (`api.sandbox.breathehr.com/v1/swagger_doc/<resource>`). Authenticatie verloopt via een API-sleutel in de header en de sandbox draait op dezelfde specificatie. In de loop der tijd zijn modules toegevoegd voor uitgebreide declaraties (expense_claims + losse expenses), company_projects, employee_training_courses en change_requests voor contract- en salariswijzigingen. Rate limits zijn gedocumenteerd op het developer-portaal.

API versies

Expense claims Major release

Uitbreiding met CRUD voor employee_expense_claims en losse employee_expenses voor gedetailleerde declaratie-administratie.

Department-scoped endpoints

Per-afdeling endpoints voor absences, salaries, bonuses en benefits (bijv. `/departments/{id}/absences`) voor granulaire toegang.

Change requests Major release

Change_requests-endpoints voor goedkeuringsflows op contract- en salariswijzigingen.