API configuration: bambookhr, bamboohr-basic


Auth (Basic)
Sync data
Perform workflows
Proxy requests
Receive webhooks🚫 (time to contribute: <48h)
We can implement missing features in <48h, just ask for it in the community.

Getting started

Need help getting started? Get help in the community.

Connection configuration in Nango

BambooHR requires a user specific subdomain to authenticate

You should request this from the user and pass it to Nango in the nango.auth() call:

// oAuth
nango.auth('bamboohr', '<CONNECTION-ID>', {params: {subdomain: '<bamboohr-subdomain>'}});
// API key
nango.auth('bamboohr-basic', '<CONNECTION-ID>', {
        credentials: {
            username: '<END-USER-API-KEY>',
            password: 'x'
        params: {
            subdomain: '<bamboohr-subdomain>'

For more details, see the docs here.

API gotchas

  • When creating a connection, you need to add the subdomain as a params argument, for example: nango.auth('bamhoo-hr', '1', {params: {subdomain: '<your-subdomain>'}}).
  • Authenticating via API key: BambooHR gives only an API Key but uses Basic auth for the API. Pass the API Key as the username and use x for the password. See BambooHR documentation
Add Getting Started links and Gotchas by editing this page