Skip to main content

How to set up a custom report and API key for integrating Skillcast with BambooHR

Updated over 4 months ago

Follow these steps to create a custom report in BambooHR that includes only active users and to generate an API key that Skillcast can use to securely access that data.
​
Skillcast uses a custom report on the BambooHR side to extract data via the API to provision users. This is a great approach as it gives you full control over what data you do and do not share with Skillcast.

For any questions around this process, please contact your Customer Success Manager by selecting Send us a message via the help icon on your portal, or by emailing [email protected].

Step 1: Create a Custom Report in BambooHR

  1. Log in to BambooHR with Admin access.

  2. From the top menu, go to Reports.

  3. Select the "Add Report" button.

  4. Choose "Custom Report".

  5. Name the report:
    ​Active Users for Skillcast

  6. Under Columns, select the data fields you want to include, for example:

    • Employee ID

    • First Name

    • Last Name

    • Email

    • Job Title

    • Department

    • Hire Date

  7. Select Next or Save & Continue.

Step 2: Filter for Active Employees Only

  1. In the report builder, find the "Filters" section.

  2. Select "Add Filter".

  3. Choose the field called "Status" (or "Employment Status").

  4. Set the condition to:
    ​is → Active

  5. Apply the filter.

  6. Select Save to finalise the custom report.

This is an important step that ensures only active employees are included in the report and made available via the API. By default, BambooHR only shows active users in the portal, however, it makes all users (even inactive) available via the API. The step above allows us to filter out inactive users.

Step 3: Create an API Key in BambooHR

  1. From your BambooHR dashboard, click your profile icon (top right) → API Keys.

  2. Select "Add New Key".

  3. Name it:
    ​Skillcast API Access

  4. Select Generate Key.

  5. Copy the key immediately — it won't be shown again after you close the window.

Store this key securely and do not share it via email or unsecured channels.

Step 4: Share the API Key Securely with Skillcast

  1. Use one of the following secure methods to send the API key:

  • Encrypted password managers (e.g., 1Password, LastPass)

  • Skillcast file exchange via text file upload

Do not send the API key in plain text over email or Slack.

Step 5: Provide Skillcast with Access Details

Give Skillcast the following information:

  • BambooHR subdomain
    If your BambooHR URL is https://skillcast.bamboohr.com, your subdomain is "skillcast".

  • API Key
    From Step 3.

  • Report ID
    This is generally found in the URL when viewing the report. If in doubt, share the entire URL of the custom report with Skillcast.

This is all the information Skillcast needs to access the data you included in the custom report and bring it down to Skillcast to provision users. Skillcast will set up the connection from here and share a data preview for you to review.

For any questions or assistance, please contact your Customer Success Manager by selecting Send us a message via the help icon on your portal, or by emailing [email protected].

Did this answer your question?