The openbranchhq API is in beta
Read your organization, people and leave data from your other tools with scoped API keys. The API is read-only for now and part of Pro and Enterprise.
Your data, in your other tools
The REST API lets the rest of your stack read openbranchhq. Payroll can pick up approved leave, an IT system can follow who joins and leaves, and a dashboard can show who's out this week.
Every endpoint is read-only for now, and together they cover nine resources:
- The organization's profile
- Locations
- Public holidays, per location and year
- Departments
- People, with their work details
- Leave types
- Leave balances, per person and leave type
- Leave requests, with their dates, hours and status
- The team calendar: approved absences, holidays and blackouts
Keys you control
Owners and admins create keys under Settings → API keys and choose what each can read: a whole area, such as leave, or single resources like balances. A key is shown once and stored only as a fingerprint.
A key never sees more than the person who created it could see in the app, and it stops working if that person leaves the workspace. Revoke a key at any time, or let it expire after 30 days, 90 days or a year.
The API reference
The API reference documents every endpoint, parameter and field, the scope each endpoint needs and the errors it can return, generated from the same code that serves the API. Its playground sends real requests with your key, so you can see a response before writing any code.
Lists page with cursors, every error has the same shape, and each key can make 300 requests a minute.
In beta
We're still adding to the API, so new endpoints and fields will appear as it grows. Changes stay additive: nothing an integration relies on is removed or renamed. Writes and webhooks are on the roadmap.