Your data, in your other tools
A read-only REST API over your organization, people and leave data, in beta on Pro and Enterprise. Scoped keys act as the person who made them, and the reference lets you try every request.
Available on
Pro and Enterprise
- Compare plans
1.0
Three areas, nine resources
Payroll picks up approved leave and balances, IT follows joiners and leavers, and a dashboard shows who's out this week, each reading straight from openbranchhq instead of from a spreadsheet someone exports.
Lists filter the way the app does: people by status, department and location; leave requests by status, dates, leave type, department and location; the team calendar by a date range and department.
- Organization
- Profile, locations, public holidays, departments
- People
- Work details, employee number, date of birth, manager
- Leave
- Types, balances, requests, the team calendar
- Left out
- Leave notes
- Organization — its name and URL, locations with their time zone, leave year and working week, each location's public holidays by year, and departments.
- People — work details, employee number, date of birth, manager, location and department.
- Leave — leave types, each person's balance by leave type, leave requests with their dates, hours and status, and the calendar of approved leave, holidays and blackouts.
2.0
Keys you control
Owners and admins create keys under Settings → API keys, one per tool, so each can be revoked alone. A key is shown once, when it's created; only a fingerprint of it is stored, so a lost key is replaced, never recovered.
Each key holds scopes: a whole area, which also covers what the area gains later, or single resources such as leave balances. It acts as the person who created it and never reads more than they could in the app. Removing or archiving that person stops the key for good, as does revoking it or reaching the expiry it was given: 30 days, 90 days or a year.
3.0
A reference you can try
The API reference lists every endpoint, parameter, field, scope and error. It's generated from the same code that serves the API, so it can't drift from what a request returns, and its playground sends requests with your own key.
Every endpoint follows the same rules, so the second integration goes quicker than the first.
- Pagination
- Cursors, up to 100 items a page
- Errors
- One envelope: a code and the matching HTTP status
- Rate limit
- 300 requests a minute per key, the rest counted on every response
- Formats
- snake_case fields, UTC timestamps, YYYY-MM-DD dates, hours
4.0
In beta, and additive
The API reads; it doesn't write yet. Write endpoints come later, and webhooks are on the roadmap.
Within /v1 every change is additive: new endpoints, fields and values may appear, but nothing an integration relies on is removed or renamed, and no field changes its meaning. Each change is checked against the published reference before it ships; one that would break an integration ships as a new version, with /v1 still served beside it.
API access is part of Pro and Enterprise. If a workspace moves to Free, its keys are kept but every request is refused until it upgrades again.
FAQ
API, answered
Still have a question? Email us
Can the API change data?
Not yet. Every endpoint reads, and a key reads only what its scopes and its creator's role allow. Write endpoints come later; webhooks are on the roadmap.
Will my integration break during the beta?
No. Changes stay additive: new endpoints and fields may appear, so ignore the ones you don't recognise, but nothing is removed or renamed within /v1.
What happens to a key when the person who created it leaves?
It stops working the moment they're removed from the organization or archived, and a rehire doesn't bring it back. Create the new key as someone who's staying.
Keep exploring
Related features
Retire the leave spreadsheet. Start free today.
Set up a workspace in minutes. Your data stays yours: every leave request exports to CSV, any time.