> For the complete documentation index, see [llms.txt](https://integrations.drivetrain.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.drivetrain.ai/integration-guide/readme/hris-and-ats/integrating-with-darwinbox.md).
# Integrating with Darwinbox
Sync Darwinbox HR data with Drivetrain to power accurate headcount planning. Covers creating API keys in Darwinbox Studio or getting them from Darwinbox.
[Prerequisites](#prerequisites)
[Case one: When you have access to the Darwinbox Studio module](#case-one-when-you-have-access-to-darwinbox-studio-module)\
[Step 1: Create a Studio user](#step-1-create-a-studio-user)\
[Step 2: Create an API key](#step-2-create-an-api-key)\
[Case two: When you don't have access to the Darwinbox Studio module](#case-two-when-you-dont-have-access-to-darwinbox-studio-module)\
[Step 1: Contact your Darwinbox account manager](#step-1-contact-your-darwinbox-account-manager)
Darwinbox has two methods to integrate with their APIs:
1. If you have the **Darwinbox Studio** module as part of your Darwinbox subscription, you can create an API key yourself.
2. If you don't have the Darwinbox Studio module, you need to reach out to your Darwinbox account manager.
## Prerequisites
1. An active Darwinbox admin account.
## Case one: When you have access to the Darwinbox Studio module
### Step 1: Create a Studio user
1. Log in to your Darwinbox account with the super admin role, and go to the **Modules** page.
2. Click **Darwinbox Studio**.
3. Under the **Studio Users** tab, click **Add Studio User**.
4. Add the following user details on the next screen:
1. Enter the username **Drivetrain Integration**.
2. Select **External** as the type.
3. Enter the email address shared by your Drivetrain customer success manager.
4. Enter a unique user ID.
5. Enter a strong password.
{% hint style="info" %}
Username and Password are needed for authentication.
{% endhint %}
### Step 2: Create an API key
1. Under the **Darwinbox API Keys** tab, click **Configure Darwinbox API**.
2. Drivetrain fetches data from two essential APIs. If you need more APIs pulled, raise this with your Drivetrain CSM.
1. [Employee Data](https://api-docs.darwinbox.com/#e3afba06-d4cf-479e-8605-26388b14eda3)
2. [Employee CTC Data](https://api-docs.darwinbox.com/#981af6ff-0fac-42f2-bec4-78b8466260aa)
3. Add the following API details on the next screen:
1. Enter **static key** as the key type.
2. Enter the API configuration name as **Drivetrain Integration Employee Data**.
3. Select the user created in the previous step.
4. Select the module you want to pull into Drivetrain: **Core** for the Employee Data API, and **Compensation** for the Employee CTC Data API.
5. Select the endpoint `/masterapi/employee` for employee data and `/payrollapi/ctcbreakup` for employee CTC data.
6. Click **Create**.
{% hint style="info" %}
You need to create a separate API key for each API.
{% endhint %}
{% hint style="info" %}
That’s it! Share the API keys, the dataset keys for both modules, and the username and password with your Drivetrain customer success manager.
{% endhint %}
## Case two: When you don't have access to the Darwinbox Studio module
### Step 1: Contact your Darwinbox account manager
1. Initiate a request with your Darwinbox account manager regarding an integration with Drivetrain.
2. Ask the Darwinbox team to create a user named **Drivetrain Integration**.
3. Ask the Darwinbox team to create API keys for the following APIs:
1. [Employee Data](https://api-docs.darwinbox.com/#e3afba06-d4cf-479e-8605-26388b14eda3)
2. [Employee CTC Data](https://api-docs.darwinbox.com/#981af6ff-0fac-42f2-bec4-78b8466260aa)
{% hint style="info" %}
That’s it! Share the API keys, the dataset keys for both modules, and the username and password with your Drivetrain customer success manager.
{% endhint %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://integrations.drivetrain.ai/integration-guide/readme/hris-and-ats/integrating-with-darwinbox.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.