BambooHR Authenticate an Element Instance

You can authenticate with BambooHR to create your own instance of the BambooHR element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the BambooHR platform.

Authenticate Through the UI

Use the UI to authenticate with BambooHR and create an element instance. You will need your API key and BambooHR Domain that you identified in BambooHR API Provider Setup.

If you are configuring events, see the Events section.

To authenticate an instance, complete the steps described in Authenticate an Element Instance (UI). in addition to the base authentication parameters, you must also include:

Authenticate Through API

Send a request to our /instances endpoint to authenticate an instance. When finished note the token and id.

To authenticate an instance:

  1. Construct a JSON body as shown below (see Parameters):

      "element": {
        "key": "bamboohr"
      "configuration": {
        "username": "<BambooHR API key>",
        "": "<BambooHR BambooHR Domain>"
      "tags": [
      "name": "<INSTANCE_NAME>"
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
  3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "bamboohr"
  "configuration": {
    "username": "xxxxxxxxxxxxxxxxxx",
    "": "Acme"
  "tags": [
  "name": "API Instance"


Note: Event-related parameters are described in Events.
ParameterDescriptionData Type
keyThe element key.
The name of the element instance created during authentication.string
The BambooHR API key assigned to the user that you noted in API Provider Setup.string
Company Name
The BambooHR Domain Name. The Domain Name appears in the url of your account. For example, in the Domain Name is company_name.string
tagsOptional. User-defined tags to further identify the instance.string

Example Response for an Authenticated Element Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

  "name":"API Instance",
    "name":"Bamboo HR",
    "description":"The API can be used to manipulate employee data and to generate reports in several formats.",
    "resources":[  ],
    "parameters":[  ],

  "configuration":{  },